software.amazon.awssdk.services.lexruntime.model

Class PutSessionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.lexruntime.model.LexRuntimeResponse

software.amazon.awssdk.services.lexruntime.model.PutSessionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutSessionResponse.Builder,PutSessionResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class PutSessionResponse
extends LexRuntimeResponse
implements ToCopyableBuilder<PutSessionResponse.Builder,PutSessionResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutSessionResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	activeContexts() A list of active contexts for the session.
static PutSessionResponse.Builder	builder()
String	contentType() Content type as specified in the Accept HTTP header in the request.
DialogState	dialogState()
String	dialogStateAsString()
String	encodedMessage() The next message that should be presented to the user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	intentName() The name of the current intent.
String	message() Deprecated. The message field is deprecated, use the encodedMessage field instead. The message field is available only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR and it-IT locales.
MessageFormatType	messageFormat() The format of the response message.
String	messageFormatAsString() The format of the response message.
List<SdkField<?>>	sdkFields()
static Class<? extends PutSessionResponse.Builder>	serializableBuilderClass()
String	sessionAttributes() Map of key/value pairs representing session-specific context information.
String	sessionId() A unique identifier for the session.
String	slots() Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.
String	slotToElicit() If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
PutSessionResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.lexruntime.model.LexRuntimeResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

contentType

public final String contentType()

Content type as specified in the Accept HTTP header in the request.

Returns:

Content type as specified in the Accept HTTP header in the request.

intentName

public final String intentName()

The name of the current intent.

Returns:

The name of the current intent.

slots

public final String slots()

Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.

Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy the default is ORIGINAL_VALUE.

Returns:

Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.

Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy the default is ORIGINAL_VALUE.

sessionAttributes

public final String sessionAttributes()

Map of key/value pairs representing session-specific context information.

Returns:

Map of key/value pairs representing session-specific context information.

message

@Deprecated
public final String message()

Deprecated. The message field is deprecated, use the encodedMessage field instead. The message field is available only in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR and it-IT locales.

The next message that should be presented to the user.

You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the message field is null. You should use the encodedMessage field instead.

Returns:

The next message that should be presented to the user.

You can only use this field in the de-DE, en-AU, en-GB, en-US, es-419, es-ES, es-US, fr-CA, fr-FR, and it-IT locales. In all other locales, the message field is null. You should use the encodedMessage field instead.

encodedMessage

public final String encodedMessage()

The next message that should be presented to the user.

The encodedMessage field is base-64 encoded. You must decode the field before you can use the value.

Returns:

The next message that should be presented to the user.

The encodedMessage field is base-64 encoded. You must decode the field before you can use the value.

messageFormat

public final MessageFormatType messageFormat()

The format of the response message. One of the following values:

• PlainText - The message contains plain UTF-8 text.

• CustomPayload - The message is a custom format for the client.

• SSML - The message contains text formatted for voice output.

• Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

If the service returns an enum value that is not available in the current SDK version, messageFormat will return MessageFormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageFormatAsString().

Returns:

The format of the response message. One of the following values:

• PlainText - The message contains plain UTF-8 text.

• CustomPayload - The message is a custom format for the client.

• SSML - The message contains text formatted for voice output.

• Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

See Also:

MessageFormatType

messageFormatAsString

public final String messageFormatAsString()

The format of the response message. One of the following values:

• PlainText - The message contains plain UTF-8 text.

• CustomPayload - The message is a custom format for the client.

• SSML - The message contains text formatted for voice output.

• Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

If the service returns an enum value that is not available in the current SDK version, messageFormat will return MessageFormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageFormatAsString().

Returns:

The format of the response message. One of the following values:

• PlainText - The message contains plain UTF-8 text.

• CustomPayload - The message is a custom format for the client.

• SSML - The message contains text formatted for voice output.

• Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

See Also:

MessageFormatType

dialogState

public final DialogState dialogState()

• ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before fulfilling an intent.

• ElicitIntent - Amazon Lex wants to elicit the user's intent.

• ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

• Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.

• Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.

• ReadyForFulfillment - Conveys that the client has to fulfill the intent.

If the service returns an enum value that is not available in the current SDK version, dialogState will return DialogState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dialogStateAsString().

Returns:

• ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before fulfilling an intent.

• ElicitIntent - Amazon Lex wants to elicit the user's intent.

• ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

• Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.

• Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.

• ReadyForFulfillment - Conveys that the client has to fulfill the intent.

See Also:

DialogState

dialogStateAsString

public final String dialogStateAsString()

• ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before fulfilling an intent.

• ElicitIntent - Amazon Lex wants to elicit the user's intent.

• ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

• Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.

• Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.

• ReadyForFulfillment - Conveys that the client has to fulfill the intent.

If the service returns an enum value that is not available in the current SDK version, dialogState will return DialogState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dialogStateAsString().

Returns:

• ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before fulfilling an intent.

• ElicitIntent - Amazon Lex wants to elicit the user's intent.

• ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

• Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.

• Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.

• ReadyForFulfillment - Conveys that the client has to fulfill the intent.

See Also:

DialogState

slotToElicit

public final String slotToElicit()

If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

Returns:

If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

sessionId

public final String sessionId()

A unique identifier for the session.

Returns:

A unique identifier for the session.

activeContexts

public final String activeContexts()

A list of active contexts for the session.

Returns:

A list of active contexts for the session.

toBuilder

public PutSessionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutSessionResponse.Builder,PutSessionResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static PutSessionResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo