Package software.amazon.awssdk.services.lexruntimev2.model

Class SessionState

java.lang.Object
software.amazon.awssdk.services.lexruntimev2.model.SessionState
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SessionState.Builder,SessionState>
@Generated("software.amazon.awssdk:codegen") public final class SessionState extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SessionState.Builder,SessionState>

The state of the user's session with Amazon Lex V2.

See Also:

  • Method Details

    • dialogAction

      public final DialogAction dialogAction()

      The next step that Amazon Lex V2 should take in the conversation with a user.

      Returns:
      The next step that Amazon Lex V2 should take in the conversation with a user.

    • intent

      public final Intent intent()

      The active intent that Amazon Lex V2 is processing.

      Returns:
      The active intent that Amazon Lex V2 is processing.

    • 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()

      One or more contexts that indicate to Amazon Lex V2 the context of a request. When a context is active, Amazon Lex V2 considers intents with the matching context as a trigger as the next intent in a session.

      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:
      One or more contexts that indicate to Amazon Lex V2 the context of a request. When a context is active, Amazon Lex V2 considers intents with the matching context as a trigger as the next intent in a session.

    • 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 session-specific context information. It contains application information passed between Amazon Lex V2 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 session-specific context information. It contains application information passed between Amazon Lex V2 and a client application.

    • originatingRequestId

      public final String originatingRequestId()

      A unique identifier for a specific request.

      Returns:
      A unique identifier for a specific request.

    • runtimeHints

      public final RuntimeHints runtimeHints()

      Hints for phrases that a customer is likely to use for a slot. Amazon Lex V2 uses the hints to help determine the correct value of a slot.

      Returns:
      Hints for phrases that a customer is likely to use for a slot. Amazon Lex V2 uses the hints to help determine the correct value of a slot.

    • toBuilder

      public SessionState.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<SessionState.Builder,SessionState>
      Returns:
      a builder for type T

    • builder

      public static SessionState.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.