PostTextResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.lexruntime.model.PostTextResult

All Implemented Interfaces:: Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PostTextResult()

Constructors
Constructor and Description
`PostTextResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PostTextResult`	`addSessionAttributesEntry(String key, String value)`
`PostTextResult`	`addSlotsEntry(String key, String value)`
`PostTextResult`	`clearSessionAttributesEntries()` Removes all the entries added into SessionAttributes.
`PostTextResult`	`clearSlotsEntries()` Removes all the entries added into Slots.
`PostTextResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDialogState()` Identifies the current state of the user interaction.
`String`	`getIntentName()` The current user intent that Amazon Lex is aware of.
`String`	`getMessage()` The message to convey to the user.
`String`	`getMessageFormat()` The format of the response message.
`ResponseCard`	`getResponseCard()` Represents the options that the user has to respond to the current prompt.
`SentimentResponse`	`getSentimentResponse()` The sentiment expressed in and utterance.
`Map<String,String>`	`getSessionAttributes()` A map of key-value pairs representing the session-specific context information.
`String`	`getSessionId()` A unique identifier for the session.
`Map<String,String>`	`getSlots()` The intent slots that Amazon Lex detected from the user input in the conversation.
`String`	`getSlotToElicit()` If the `dialogState` value is `ElicitSlot`, returns the name of the slot for which Amazon Lex is eliciting a value.
`int`	`hashCode()`
`void`	`setDialogState(DialogState dialogState)` Identifies the current state of the user interaction.
`void`	`setDialogState(String dialogState)` Identifies the current state of the user interaction.
`void`	`setIntentName(String intentName)` The current user intent that Amazon Lex is aware of.
`void`	`setMessage(String message)` The message to convey to the user.
`void`	`setMessageFormat(MessageFormatType messageFormat)` The format of the response message.
`void`	`setMessageFormat(String messageFormat)` The format of the response message.
`void`	`setResponseCard(ResponseCard responseCard)` Represents the options that the user has to respond to the current prompt.
`void`	`setSentimentResponse(SentimentResponse sentimentResponse)` The sentiment expressed in and utterance.
`void`	`setSessionAttributes(Map<String,String> sessionAttributes)` A map of key-value pairs representing the session-specific context information.
`void`	`setSessionId(String sessionId)` A unique identifier for the session.
`void`	`setSlots(Map<String,String> slots)` The intent slots that Amazon Lex detected from the user input in the conversation.
`void`	`setSlotToElicit(String slotToElicit)` If the `dialogState` value 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.
`PostTextResult`	`withDialogState(DialogState dialogState)` Identifies the current state of the user interaction.
`PostTextResult`	`withDialogState(String dialogState)` Identifies the current state of the user interaction.
`PostTextResult`	`withIntentName(String intentName)` The current user intent that Amazon Lex is aware of.
`PostTextResult`	`withMessage(String message)` The message to convey to the user.
`PostTextResult`	`withMessageFormat(MessageFormatType messageFormat)` The format of the response message.
`PostTextResult`	`withMessageFormat(String messageFormat)` The format of the response message.
`PostTextResult`	`withResponseCard(ResponseCard responseCard)` Represents the options that the user has to respond to the current prompt.
`PostTextResult`	`withSentimentResponse(SentimentResponse sentimentResponse)` The sentiment expressed in and utterance.
`PostTextResult`	`withSessionAttributes(Map<String,String> sessionAttributes)` A map of key-value pairs representing the session-specific context information.
`PostTextResult`	`withSessionId(String sessionId)` A unique identifier for the session.
`PostTextResult`	`withSlots(Map<String,String> slots)` The intent slots that Amazon Lex detected from the user input in the conversation.
`PostTextResult`	`withSlotToElicit(String slotToElicit)` If the `dialogState` value 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
  - PostTextResult
```
public PostTextResult()
```
- Method Detail
  - setIntentName
```
public void setIntentName(String intentName)
```
    The current user intent that Amazon Lex is aware of.
    
    Parameters:
    
    intentName - The current user intent that Amazon Lex is aware of.
  - getIntentName
```
public String getIntentName()
```
    The current user intent that Amazon Lex is aware of.
    
    Returns:
    
    The current user intent that Amazon Lex is aware of.
  - withIntentName
```
public PostTextResult withIntentName(String intentName)
```
    The current user intent that Amazon Lex is aware of.
    
    Parameters:
    
    intentName - The current user intent that Amazon Lex is aware of.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSlots
```
public Map<String,String> getSlots()
```
    The intent slots that Amazon Lex detected from the user input in 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:
    
    The intent slots that Amazon Lex detected from the user input in 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.
  - setSlots
```
public void setSlots(Map<String,String> slots)
```
    The intent slots that Amazon Lex detected from the user input in 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.
    
    Parameters:
    
    slots - The intent slots that Amazon Lex detected from the user input in 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 PostTextResult withSlots(Map<String,String> slots)
```
    The intent slots that Amazon Lex detected from the user input in 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.
    
    Parameters:
    
    slots - The intent slots that Amazon Lex detected from the user input in 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.
  - addSlotsEntry
```
public PostTextResult addSlotsEntry(String key,
                                    String value)
```
  - clearSlotsEntries
```
public PostTextResult clearSlotsEntries()
```
    Removes all the entries added into Slots.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSessionAttributes
```
public Map<String,String> getSessionAttributes()
```
    A map of key-value pairs representing the session-specific context information.
    
    Returns:
    
    A map of key-value pairs representing the session-specific context information.
  - setSessionAttributes
```
public void setSessionAttributes(Map<String,String> sessionAttributes)
```
    A map of key-value pairs representing the session-specific context information.
    
    Parameters:
    
    sessionAttributes - A map of key-value pairs representing the session-specific context information.
  - withSessionAttributes
```
public PostTextResult withSessionAttributes(Map<String,String> sessionAttributes)
```
    A map of key-value pairs representing the session-specific context information.
    
    Parameters:
    
    sessionAttributes - A map of key-value pairs representing the session-specific context information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addSessionAttributesEntry
```
public PostTextResult addSessionAttributesEntry(String key,
                                                String value)
```
  - clearSessionAttributesEntries
```
public PostTextResult clearSessionAttributesEntries()
```
    Removes all the entries added into SessionAttributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessage
```
public void setMessage(String message)
```
    The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
    
    If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
    
    When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
    
    If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
    
    Parameters:
    
    message - The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
    
    If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
    
    When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
    
    If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
  - getMessage
```
public String getMessage()
```
    The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
    
    If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
    
    When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
    
    If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
    
    Returns:
    
    The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
    
    If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
    
    When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
    
    If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
  - withMessage
```
public PostTextResult withMessage(String message)
```
    The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
    
    If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
    
    When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
    
    If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
    
    Parameters:
    
    message - The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
    
    If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
    
    When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
    
    If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSentimentResponse
```
public void setSentimentResponse(SentimentResponse sentimentResponse)
```
    The sentiment expressed in and utterance.
    
    When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.
    
    Parameters:
    
    sentimentResponse - The sentiment expressed in and utterance.
    
    When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.
  - getSentimentResponse
```
public SentimentResponse getSentimentResponse()
```
    The sentiment expressed in and utterance.
    
    When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.
    
    Returns:
    
    The sentiment expressed in and utterance.
    
    When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.
  - withSentimentResponse
```
public PostTextResult withSentimentResponse(SentimentResponse sentimentResponse)
```
    The sentiment expressed in and utterance.
    
    When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.
    
    Parameters:
    
    sentimentResponse - The sentiment expressed in and utterance.
    
    When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.
    
    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 defined by the Lambda function.
    - 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 defined by the Lambda function.
    
    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 defined by the Lambda function.
    - 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 defined by the Lambda function.
    
    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 PostTextResult 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 defined by the Lambda function.
    - 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 defined by the Lambda function.
    
    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
  - setMessageFormat
```
public void setMessageFormat(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 defined by the Lambda function.
    - 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 defined by the Lambda function.
    
    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 PostTextResult 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 defined by the Lambda function.
    - 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 defined by the Lambda function.
    
    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)
```
    Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
    - ElicitIntent - Amazon Lex wants to elicit user intent.
      
      For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.
    - ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
      
      For example, Amazon Lex wants user confirmation before fulfilling an intent.
      
      Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).
    - ElicitSlot - Amazon Lex is expecting a slot value for the current intent.
      
      For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
    - Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.
    - ReadyForFulfillment - Conveys that the client has to fulfill the intent.
    - Failed - Conveys that the conversation with the user failed.
      
      This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.
    Parameters:
    dialogState - Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
    
    ElicitIntent - Amazon Lex wants to elicit user intent.
    
    For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.
    
    ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
    
    For example, Amazon Lex wants user confirmation before fulfilling an intent.
    
    Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).
    
    ElicitSlot - Amazon Lex is expecting a slot value for the current intent.
    
    For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
    
    Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.
    
    ReadyForFulfillment - Conveys that the client has to fulfill the intent.
    
    Failed - Conveys that the conversation with the user failed.
    
    This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.
    See Also:
    
    DialogState
  - getDialogState
```
public String getDialogState()
```
    Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
    - ElicitIntent - Amazon Lex wants to elicit user intent.
      
      For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.
    - ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
      
      For example, Amazon Lex wants user confirmation before fulfilling an intent.
      
      Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).
    - ElicitSlot - Amazon Lex is expecting a slot value for the current intent.
      
      For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
    - Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.
    - ReadyForFulfillment - Conveys that the client has to fulfill the intent.
    - Failed - Conveys that the conversation with the user failed.
      
      This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.
    Returns:
    Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
    
    ElicitIntent - Amazon Lex wants to elicit user intent.
    
    For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.
    
    ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
    
    For example, Amazon Lex wants user confirmation before fulfilling an intent.
    
    Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).
    
    ElicitSlot - Amazon Lex is expecting a slot value for the current intent.
    
    For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
    
    Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.
    
    ReadyForFulfillment - Conveys that the client has to fulfill the intent.
    
    Failed - Conveys that the conversation with the user failed.
    
    This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.
    See Also:
    
    DialogState
  - withDialogState
```
public PostTextResult withDialogState(String dialogState)
```
    Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
    - ElicitIntent - Amazon Lex wants to elicit user intent.
      
      For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.
    - ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
      
      For example, Amazon Lex wants user confirmation before fulfilling an intent.
      
      Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).
    - ElicitSlot - Amazon Lex is expecting a slot value for the current intent.
      
      For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
    - Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.
    - ReadyForFulfillment - Conveys that the client has to fulfill the intent.
    - Failed - Conveys that the conversation with the user failed.
      
      This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.
    Parameters:
    dialogState - Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
    
    ElicitIntent - Amazon Lex wants to elicit user intent.
    
    For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.
    
    ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
    
    For example, Amazon Lex wants user confirmation before fulfilling an intent.
    
    Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).
    
    ElicitSlot - Amazon Lex is expecting a slot value for the current intent.
    
    For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
    
    Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.
    
    ReadyForFulfillment - Conveys that the client has to fulfill the intent.
    
    Failed - Conveys that the conversation with the user failed.
    
    This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DialogState
  - setDialogState
```
public void setDialogState(DialogState dialogState)
```
    Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
    - ElicitIntent - Amazon Lex wants to elicit user intent.
      
      For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.
    - ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
      
      For example, Amazon Lex wants user confirmation before fulfilling an intent.
      
      Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).
    - ElicitSlot - Amazon Lex is expecting a slot value for the current intent.
      
      For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
    - Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.
    - ReadyForFulfillment - Conveys that the client has to fulfill the intent.
    - Failed - Conveys that the conversation with the user failed.
      
      This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.
    Parameters:
    dialogState - Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
    
    ElicitIntent - Amazon Lex wants to elicit user intent.
    
    For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.
    
    ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
    
    For example, Amazon Lex wants user confirmation before fulfilling an intent.
    
    Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).
    
    ElicitSlot - Amazon Lex is expecting a slot value for the current intent.
    
    For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
    
    Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.
    
    ReadyForFulfillment - Conveys that the client has to fulfill the intent.
    
    Failed - Conveys that the conversation with the user failed.
    
    This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.
    See Also:
    
    DialogState
  - withDialogState
```
public PostTextResult withDialogState(DialogState dialogState)
```
    Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
    - ElicitIntent - Amazon Lex wants to elicit user intent.
      
      For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.
    - ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
      
      For example, Amazon Lex wants user confirmation before fulfilling an intent.
      
      Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).
    - ElicitSlot - Amazon Lex is expecting a slot value for the current intent.
      
      For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
    - Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.
    - ReadyForFulfillment - Conveys that the client has to fulfill the intent.
    - Failed - Conveys that the conversation with the user failed.
      
      This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.
    Parameters:
    dialogState - Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
    
    ElicitIntent - Amazon Lex wants to elicit user intent.
    
    For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.
    
    ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
    
    For example, Amazon Lex wants user confirmation before fulfilling an intent.
    
    Instead of a simple "yes" or "no," a user might respond with additional information. For example, "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).
    
    ElicitSlot - Amazon Lex is expecting a slot value for the current intent.
    
    For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
    
    Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.
    
    ReadyForFulfillment - Conveys that the client has to fulfill the intent.
    
    Failed - Conveys that the conversation with the user failed.
    
    This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed 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 value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
    
    Parameters:
    
    slotToElicit - If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
  - getSlotToElicit
```
public String getSlotToElicit()
```
    If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
    
    Returns:
    
    If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
  - withSlotToElicit
```
public PostTextResult withSlotToElicit(String slotToElicit)
```
    If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
    
    Parameters:
    
    slotToElicit - If the dialogState value 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.
  - setResponseCard
```
public void setResponseCard(ResponseCard responseCard)
```
    Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function).
    
    Parameters:
    
    responseCard - Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function).
  - getResponseCard
```
public ResponseCard getResponseCard()
```
    Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function).
    
    Returns:
    
    Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function).
  - withResponseCard
```
public PostTextResult withResponseCard(ResponseCard responseCard)
```
    Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function).
    
    Parameters:
    
    responseCard - Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function).
    
    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 PostTextResult 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 PostTextResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class PostTextResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

PostTextResult

Method Detail

setIntentName

getIntentName

withIntentName

getSlots

setSlots

withSlots

addSlotsEntry

clearSlotsEntries

getSessionAttributes

setSessionAttributes

withSessionAttributes

addSessionAttributesEntry

clearSessionAttributesEntries

setMessage

getMessage

withMessage

setSentimentResponse

getSentimentResponse

withSentimentResponse

setMessageFormat

getMessageFormat

withMessageFormat

setMessageFormat

withMessageFormat

setDialogState

getDialogState

withDialogState

setDialogState

withDialogState

setSlotToElicit

getSlotToElicit

withSlotToElicit

setResponseCard

getResponseCard

withResponseCard

setSessionId

getSessionId

withSessionId

toString

equals

hashCode

clone