Class PutSessionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutSessionRequest.Builder,
PutSessionRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The alias identifier of the bot that receives the session data.final String
botId()
The identifier of the bot that receives the session data.static PutSessionRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Messages property.final boolean
For responses, this returns true if the service returned a value for the RequestAttributes property.final String
localeId()
The locale where the session is in use.messages()
A list of messages to send to the user.Request-specific information passed between Amazon Lex V2 and the client application.final String
The message that Amazon Lex V2 returns in the response can be either text or speech depending on the value of this parameter.static Class
<? extends PutSessionRequest.Builder> final String
The identifier of the session that receives the session data.final SessionState
Sets the state of the session with the user.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
botId
The identifier of the bot that receives the session data.
- Returns:
- The identifier of the bot that receives the session data.
-
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
The locale where the session is in use.
- Returns:
- The locale where the session is in use.
-
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
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
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
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
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
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 interfaceToCopyableBuilder<PutSessionRequest.Builder,
PutSessionRequest> - Specified by:
toBuilder
in classLexRuntimeV2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-