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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSessionState.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<ActiveContext>activeContexts()One or more contexts that indicate to Amazon Lex V2 the context of a request.static SessionState.Builderbuilder()DialogActiondialogAction()The next step that Amazon Lex V2 should take in the conversation with a user.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasActiveContexts()For responses, this returns true if the service returned a value for the ActiveContexts property.inthashCode()booleanhasSessionAttributes()For responses, this returns true if the service returned a value for the SessionAttributes property.Intentintent()The active intent that Amazon Lex V2 is processing.StringoriginatingRequestId()A unique identifier for a specific request.RuntimeHintsruntimeHints()Hints for phrases that a customer is likely to use for a slot.List<SdkField<?>>sdkFields()static Class<? extends SessionState.Builder>serializableBuilderClass()Map<String,String>sessionAttributes()Map of key/value pairs representing session-specific context information.SessionState.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SessionState.Builder,SessionState>
-
builder
public static SessionState.Builder builder()
-
serializableBuilderClass
public static Class<? extends SessionState.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-