PostTextResult (AWS SDK for Android - Amazon Lex 2.6.24 API)

java.lang.Object
- com.amazonaws.services.lexrts.model.PostTextResult

All Implemented Interfaces:: Serializable

public class PostTextResult
extends Object
implements Serializable

See Also:: 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)` A map of key-value pairs representing the session-specific context information.
`PostTextResult`	`addslotsEntry(String key, String value)` The intent slots (name/value pairs) that Amazon Lex detected so far from the user input in the conversation.
`PostTextResult`	`clearsessionAttributesEntries()` Removes all the entries added into sessionAttributes.
`PostTextResult`	`clearslotsEntries()` Removes all the entries added into slots.
`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()` A message to convey to the user.
`ResponseCard`	`getResponseCard()` Represents the options that the user has to respond to the current prompt.
`Map<String,String>`	`getSessionAttributes()` A map of key-value pairs representing the session-specific context information.
`Map<String,String>`	`getSlots()` The intent slots (name/value pairs) that Amazon Lex detected so far 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)` A message to convey to the user.
`void`	`setResponseCard(ResponseCard responseCard)` Represents the options that the user has to respond to the current prompt.
`void`	`setSessionAttributes(Map<String,String> sessionAttributes)` A map of key-value pairs representing the session-specific context information.
`void`	`setSlots(Map<String,String> slots)` The intent slots (name/value pairs) that Amazon Lex detected so far 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; useful for testing and debugging.
`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)` A message to convey to the user.
`PostTextResult`	`withResponseCard(ResponseCard responseCard)` Represents the options that the user has to respond to the current prompt.
`PostTextResult`	`withSessionAttributes(Map<String,String> sessionAttributes)` A map of key-value pairs representing the session-specific context information.
`PostTextResult`	`withSlots(Map<String,String> slots)` The intent slots (name/value pairs) that Amazon Lex detected so far 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 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PostTextResult
```
public PostTextResult()
```
- Method Detail
  - 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.
  - 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.
  - withIntentName
```
public PostTextResult withIntentName(String intentName)
```
    The current user intent that Amazon Lex is aware of.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    intentName -
    The current user intent that Amazon Lex is aware of.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSlots
```
public Map<String,String> getSlots()
```
    The intent slots (name/value pairs) that Amazon Lex detected so far from the user input in the conversation.
    
    Returns:
    
    The intent slots (name/value pairs) that Amazon Lex detected so far from the user input in the conversation.
  - setSlots
```
public void setSlots(Map<String,String> slots)
```
    The intent slots (name/value pairs) that Amazon Lex detected so far from the user input in the conversation.
    
    Parameters:
    
    slots -
    The intent slots (name/value pairs) that Amazon Lex detected so far from the user input in the conversation.
  - withSlots
```
public PostTextResult withSlots(Map<String,String> slots)
```
    The intent slots (name/value pairs) that Amazon Lex detected so far from the user input in the conversation.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    slots -
    The intent slots (name/value pairs) that Amazon Lex detected so far from the user input in the conversation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addslotsEntry
```
public PostTextResult addslotsEntry(String key,
                                    String value)
```
    The intent slots (name/value pairs) that Amazon Lex detected so far from the user input in the conversation.
    
    The method adds a new key-value pair into slots parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into slots.
    
    value - The corresponding value of the entry to be added into slots.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearslotsEntries
```
public PostTextResult clearslotsEntries()
```
    Removes all the entries added into slots.
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    sessionAttributes -
    A map of key-value pairs representing the session-specific context information.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addsessionAttributesEntry
```
public PostTextResult addsessionAttributesEntry(String key,
                                                String value)
```
    A map of key-value pairs representing the session-specific context information.
    
    The method adds a new key-value pair into sessionAttributes parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into sessionAttributes.
    
    value - The corresponding value of the entry to be added into sessionAttributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearsessionAttributesEntries
```
public PostTextResult clearsessionAttributesEntries()
```
    Removes all the entries added into sessionAttributes.
    Returns a reference to this object so that method calls can be chained together.
  - getMessage
```
public String getMessage()
```
    A message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or the code hook returned Delegate as the dialogAction.type in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (for more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client.
    
    Constraints:
    Length: 1 - 1024
    
    Returns:
    
    A message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or the code hook returned Delegate as the dialogAction.type in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (for more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client.
  - setMessage
```
public void setMessage(String message)
```
    A message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or the code hook returned Delegate as the dialogAction.type in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (for more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client.
    
    Constraints:
    Length: 1 - 1024
    
    Parameters:
    
    message -
    A message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or the code hook returned Delegate as the dialogAction.type in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (for more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client.
  - withMessage
```
public PostTextResult withMessage(String message)
```
    A message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or the code hook returned Delegate as the dialogAction.type in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (for more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 1024
    
    Parameters:
    
    message -
    A message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or the code hook returned Delegate as the dialogAction.type in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (for more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
    Constraints:
    Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Fulfilled, ReadyForFulfillment, Failed
    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
  - 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.
    Constraints:
    Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Fulfilled, ReadyForFulfillment, Failed
    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(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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Fulfilled, ReadyForFulfillment, Failed
    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:
    
    A reference to this updated 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.
    Constraints:
    Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Fulfilled, ReadyForFulfillment, Failed
    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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Fulfilled, ReadyForFulfillment, Failed
    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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DialogState
  - 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.
  - 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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    slotToElicit -
    If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - 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).
  - 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).
  - 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).
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class PostTextResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PostTextResult

Method Detail

getIntentName

setIntentName

withIntentName

getSlots

setSlots

withSlots

addslotsEntry

clearslotsEntries

getSessionAttributes

setSessionAttributes

withSessionAttributes

addsessionAttributesEntry

clearsessionAttributesEntries

getMessage

setMessage

withMessage

getDialogState

setDialogState

withDialogState

setDialogState

withDialogState

getSlotToElicit

setSlotToElicit

withSlotToElicit

getResponseCard

setResponseCard

withResponseCard

toString

hashCode

equals