Package software.amazon.awssdk.services.lexruntime.model

Class PutSessionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lexruntime.model.LexRuntimeRequest
software.amazon.awssdk.services.lexruntime.model.PutSessionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutSessionRequest.Builder,PutSessionRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutSessionRequest extends LexRuntimeRequest implements ToCopyableBuilder<PutSessionRequest.Builder,PutSessionRequest>

  • Method Details

    • botName

      public final String botName()

      The name of the bot that contains the session data.

      Returns:
      The name of the bot that contains the session data.

    • botAlias

      public final String botAlias()

      The alias in use for the bot that contains the session data.

      Returns:
      The alias in use for the bot that contains the session data.

    • userId

      public final String userId()

      The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

      Returns:
      The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

    • hasSessionAttributes

      public final boolean hasSessionAttributes()
      For responses, this returns true if the service returned a value for the SessionAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • sessionAttributes

      public final Map<String,String> sessionAttributes()

      Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSessionAttributes() method.

      Returns:
      Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

    • dialogAction

      public final DialogAction dialogAction()

      Sets the next action that the bot should take to fulfill the conversation.

      Returns:
      Sets the next action that the bot should take to fulfill the conversation.

    • hasRecentIntentSummaryView

      public final boolean hasRecentIntentSummaryView()
      For responses, this returns true if the service returned a value for the RecentIntentSummaryView property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • recentIntentSummaryView

      public final List<IntentSummary> recentIntentSummaryView()

      A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

      An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

      • intentName

      • slot names

      • slotToElict

      If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRecentIntentSummaryView() method.

      Returns:
      A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

      An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

      • intentName

      • slot names

      • slotToElict

      If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

    • accept

      public final String accept()

      The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

      • If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

      • If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

      • If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.

      • The following are the accepted values:

        • audio/mpeg

        • audio/ogg

        • audio/pcm

        • audio/* (defaults to mpeg)

        • text/plain; charset=utf-8

      Returns:
      The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

      • If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

      • If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

      • If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.

      • The following are the accepted values:

        • audio/mpeg

        • audio/ogg

        • audio/pcm

        • audio/* (defaults to mpeg)

        • text/plain; charset=utf-8

    • hasActiveContexts

      public final boolean hasActiveContexts()
      For responses, this returns true if the service returned a value for the ActiveContexts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • activeContexts

      public final List<ActiveContext> activeContexts()

      A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

      If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActiveContexts() method.

      Returns:
      A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

      If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

    • toBuilder

      public PutSessionRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutSessionRequest.Builder,PutSessionRequest>
      Specified by:
      toBuilder in class LexRuntimeRequest
      Returns:
      a builder for type T

    • builder

      public static PutSessionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutSessionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.