com.amazonaws.services.lexruntime.model

Class PutSessionResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.lexruntime.model.PutSessionResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutSessionResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PutSessionResult()

Method Summary

Modifier and Type	Method and Description
PutSessionResult	clone()
boolean	equals(Object obj)
InputStream	getAudioStream() The audio version of the message to convey to the user.
String	getContentType() Content type as specified in the Accept HTTP header in the request.
String	getDialogState()
String	getIntentName() The name of the current intent.
String	getMessage() The next message that should be presented to the user.
String	getMessageFormat() The format of the response message.
String	getSessionAttributes() Map of key/value pairs representing session-specific context information.
String	getSessionId() A unique identifier for the session.
String	getSlots() Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.
String	getSlotToElicit() If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
int	hashCode()
void	setAudioStream(InputStream audioStream) The audio version of the message to convey to the user.
void	setContentType(String contentType) Content type as specified in the Accept HTTP header in the request.
void	setDialogState(String dialogState)
void	setIntentName(String intentName) The name of the current intent.
void	setMessage(String message) The next message that should be presented to the user.
void	setMessageFormat(String messageFormat) The format of the response message.
void	setSessionAttributes(String sessionAttributes) Map of key/value pairs representing session-specific context information.
void	setSessionId(String sessionId) A unique identifier for the session.
void	setSlots(String slots) Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.
void	setSlotToElicit(String slotToElicit) If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
String	toString() Returns a string representation of this object.
PutSessionResult	withAudioStream(InputStream audioStream) The audio version of the message to convey to the user.
PutSessionResult	withContentType(String contentType) Content type as specified in the Accept HTTP header in the request.
PutSessionResult	withDialogState(DialogState dialogState)
PutSessionResult	withDialogState(String dialogState)
PutSessionResult	withIntentName(String intentName) The name of the current intent.
PutSessionResult	withMessage(String message) The next message that should be presented to the user.
PutSessionResult	withMessageFormat(MessageFormatType messageFormat) The format of the response message.
PutSessionResult	withMessageFormat(String messageFormat) The format of the response message.
PutSessionResult	withSessionAttributes(String sessionAttributes) Map of key/value pairs representing session-specific context information.
PutSessionResult	withSessionId(String sessionId) A unique identifier for the session.
PutSessionResult	withSlots(String slots) Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.
PutSessionResult	withSlotToElicit(String slotToElicit) If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutSessionResult

public PutSessionResult()

Method Detail

setContentType

public void setContentType(String contentType)

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

Parameters:

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

getContentType

public String getContentType()

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.

withContentType

public PutSessionResult withContentType(String contentType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setIntentName

public void setIntentName(String intentName)

The name of the current intent.

Parameters:

intentName - The name of the current intent.

getIntentName

public String getIntentName()

The name of the current intent.

Returns:

The name of the current intent.

withIntentName

public PutSessionResult withIntentName(String intentName)

The name of the current intent.

Parameters:

intentName - The name of the current intent.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSlots

public void setSlots(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.

This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Parameters:

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.

getSlots

public String getSlots()

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.

This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "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.

withSlots

public PutSessionResult withSlots(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.

This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setSessionAttributes

public void setSessionAttributes(String sessionAttributes)

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

This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Parameters:

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

getSessionAttributes

public String getSessionAttributes()

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

This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.

Returns:

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

withSessionAttributes

public PutSessionResult withSessionAttributes(String sessionAttributes)

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

This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setMessage

public void setMessage(String message)

The next message that should be presented to the user.

Parameters:

message - The next message that should be presented to the user.

getMessage

public String getMessage()

The next message that should be presented to the user.

Returns:

The next message that should be presented to the user.

withMessage

public PutSessionResult withMessage(String message)

The next message that should be presented to the user.

Parameters:

message - The next message that should be presented to the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMessageFormat

public void setMessageFormat(String 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.

Parameters:

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.

See Also:

MessageFormatType

getMessageFormat

public String getMessageFormat()

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.

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

withMessageFormat

public PutSessionResult withMessageFormat(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MessageFormatType

withMessageFormat

public PutSessionResult withMessageFormat(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MessageFormatType

setDialogState

public void setDialogState(String 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.

Parameters:

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.

See Also:

DialogState

getDialogState

public String getDialogState()

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

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

withDialogState

public PutSessionResult withDialogState(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DialogState

withDialogState

public PutSessionResult withDialogState(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DialogState

setSlotToElicit

public void setSlotToElicit(String slotToElicit)

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

Parameters:

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

getSlotToElicit

public String getSlotToElicit()

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.

withSlotToElicit

public PutSessionResult withSlotToElicit(String slotToElicit)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setAudioStream

public void setAudioStream(InputStream audioStream)

The audio version of the message to convey to the user.

Parameters:

audioStream - The audio version of the message to convey to the user.

getAudioStream

public InputStream getAudioStream()

The audio version of the message to convey to the user.

Returns:

The audio version of the message to convey to the user.

withAudioStream

public PutSessionResult withAudioStream(InputStream audioStream)

The audio version of the message to convey to the user.

Parameters:

audioStream - The audio version of the message to convey to the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSessionId

public void setSessionId(String sessionId)

A unique identifier for the session.

Parameters:

sessionId - A unique identifier for the session.

getSessionId

public String getSessionId()

A unique identifier for the session.

Returns:

A unique identifier for the session.

withSessionId

public PutSessionResult withSessionId(String sessionId)

A unique identifier for the session.

Parameters:

sessionId - A unique identifier for the session.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutSessionResult clone()

Overrides:

clone in class Object