Class PutSessionRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.lexruntimev2.model.LexRuntimeV2Request
-
- software.amazon.awssdk.services.lexruntimev2.model.PutSessionRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<PutSessionRequest.Builder,PutSessionRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutSessionRequest extends LexRuntimeV2Request implements ToCopyableBuilder<PutSessionRequest.Builder,PutSessionRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePutSessionRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringbotAliasId()The alias identifier of the bot that receives the session data.StringbotId()The identifier of the bot that receives the session data.static PutSessionRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasMessages()For responses, this returns true if the service returned a value for the Messages property.booleanhasRequestAttributes()For responses, this returns true if the service returned a value for the RequestAttributes property.StringlocaleId()The locale where the session is in use.List<Message>messages()A list of messages to send to the user.Map<String,String>requestAttributes()Request-specific information passed between Amazon Lex V2 and the client application.StringresponseContentType()The message that Amazon Lex V2 returns in the response can be either text or speech depending on the value of this parameter.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends PutSessionRequest.Builder>serializableBuilderClass()StringsessionId()The identifier of the session that receives the session data.SessionStatesessionState()Sets the state of the session with the user.PutSessionRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
botId
public final String botId()
The identifier of the bot that receives the session data.
- Returns:
- The identifier of the bot that receives the session data.
-
botAliasId
public final String botAliasId()
The alias identifier of the bot that receives the session data.
- Returns:
- The alias identifier of the bot that receives the session data.
-
localeId
public final String localeId()
The locale where the session is in use.
- Returns:
- The locale where the session is in use.
-
sessionId
public final String sessionId()
The identifier of the session that receives the session data.
- Returns:
- The identifier of the session that receives the session data.
-
hasMessages
public final boolean hasMessages()
For responses, this returns true if the service returned a value for the Messages 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.
-
messages
public final List<Message> messages()
A list of messages to send to the user. Messages are sent in the order that they are defined in the list.
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
hasMessages()method.- Returns:
- A list of messages to send to the user. Messages are sent in the order that they are defined in the list.
-
sessionState
public final SessionState sessionState()
Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.
- Returns:
- Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex V2 should use in the conversation with the user.
-
hasRequestAttributes
public final boolean hasRequestAttributes()
For responses, this returns true if the service returned a value for the RequestAttributes 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.
-
requestAttributes
public final Map<String,String> requestAttributes()
Request-specific information passed between Amazon Lex V2 and the client application.
The namespace
x-amz-lex:is reserved for special attributes. Don't create any request attributes with the prefixx-amz-lex:.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
hasRequestAttributes()method.- Returns:
- Request-specific information passed between Amazon Lex V2 and the client application.
The namespace
x-amz-lex:is reserved for special attributes. Don't create any request attributes with the prefixx-amz-lex:.
-
responseContentType
public final String responseContentType()
The message that Amazon Lex V2 returns in the response can be either text or speech depending on the value of this parameter.
-
If the value is
text/plain; charset=utf-8, Amazon Lex V2 returns text in the response.
- Returns:
- The message that Amazon Lex V2 returns in the response can be either text or speech depending on the
value of this parameter.
-
If the value is
text/plain; charset=utf-8, Amazon Lex V2 returns text in the response.
-
-
-
toBuilder
public PutSessionRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PutSessionRequest.Builder,PutSessionRequest>- Specified by:
toBuilderin classLexRuntimeV2Request
-
builder
public static PutSessionRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends PutSessionRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-