@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DialogAction extends Object implements Serializable, Cloneable, StructuredPojo
Describes the next action that the bot should take in its interaction with the user and provides information about
the context in which the action takes place. Use the DialogAction
data type to set the interaction to a
specific state, or to return the interaction to a previous state.
Constructor and Description |
---|
DialogAction() |
Modifier and Type | Method and Description |
---|---|
DialogAction |
addSlotsEntry(String key,
String value)
Add a single Slots entry
|
DialogAction |
clearSlotsEntries()
Removes all the entries added into Slots.
|
DialogAction |
clone() |
boolean |
equals(Object obj) |
String |
getFulfillmentState()
The fulfillment state of the intent.
|
String |
getIntentName()
The name of the intent.
|
String |
getMessage()
The message that should be shown to the user.
|
String |
getMessageFormat()
|
Map<String,String> |
getSlots()
Map of the slots that have been gathered and their values.
|
String |
getSlotToElicit()
The name of the slot that should be elicited from the user.
|
String |
getType()
The next action that the bot should take in its interaction with the user.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setFulfillmentState(String fulfillmentState)
The fulfillment state of the intent.
|
void |
setIntentName(String intentName)
The name of the intent.
|
void |
setMessage(String message)
The message that should be shown to the user.
|
void |
setMessageFormat(String messageFormat)
|
void |
setSlots(Map<String,String> slots)
Map of the slots that have been gathered and their values.
|
void |
setSlotToElicit(String slotToElicit)
The name of the slot that should be elicited from the user.
|
void |
setType(String type)
The next action that the bot should take in its interaction with the user.
|
String |
toString()
Returns a string representation of this object.
|
DialogAction |
withFulfillmentState(FulfillmentState fulfillmentState)
The fulfillment state of the intent.
|
DialogAction |
withFulfillmentState(String fulfillmentState)
The fulfillment state of the intent.
|
DialogAction |
withIntentName(String intentName)
The name of the intent.
|
DialogAction |
withMessage(String message)
The message that should be shown to the user.
|
DialogAction |
withMessageFormat(MessageFormatType messageFormat)
|
DialogAction |
withMessageFormat(String messageFormat)
|
DialogAction |
withSlots(Map<String,String> slots)
Map of the slots that have been gathered and their values.
|
DialogAction |
withSlotToElicit(String slotToElicit)
The name of the slot that should be elicited from the user.
|
DialogAction |
withType(DialogActionType type)
The next action that the bot should take in its interaction with the user.
|
DialogAction |
withType(String type)
The next action that the bot should take in its interaction with the user.
|
public void setType(String type)
The next action that the bot should take in its interaction with the user. The possible values are:
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be
fulfilled. This is a yes/no question such as "Place the order?"
Close
- Indicates that the there will not be a response from the user. For example, the statement
"Your order has been placed" does not require a response.
Delegate
- The next action is determined by Amazon Lex.
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill.
ElicitSlot
- The next action is to elicit a slot value from the user.
type
- The next action that the bot should take in its interaction with the user. The possible values are:
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be
fulfilled. This is a yes/no question such as "Place the order?"
Close
- Indicates that the there will not be a response from the user. For example, the
statement "Your order has been placed" does not require a response.
Delegate
- The next action is determined by Amazon Lex.
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill.
ElicitSlot
- The next action is to elicit a slot value from the user.
DialogActionType
public String getType()
The next action that the bot should take in its interaction with the user. The possible values are:
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be
fulfilled. This is a yes/no question such as "Place the order?"
Close
- Indicates that the there will not be a response from the user. For example, the statement
"Your order has been placed" does not require a response.
Delegate
- The next action is determined by Amazon Lex.
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill.
ElicitSlot
- The next action is to elicit a slot value from the user.
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be
fulfilled. This is a yes/no question such as "Place the order?"
Close
- Indicates that the there will not be a response from the user. For example, the
statement "Your order has been placed" does not require a response.
Delegate
- The next action is determined by Amazon Lex.
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill.
ElicitSlot
- The next action is to elicit a slot value from the user.
DialogActionType
public DialogAction withType(String type)
The next action that the bot should take in its interaction with the user. The possible values are:
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be
fulfilled. This is a yes/no question such as "Place the order?"
Close
- Indicates that the there will not be a response from the user. For example, the statement
"Your order has been placed" does not require a response.
Delegate
- The next action is determined by Amazon Lex.
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill.
ElicitSlot
- The next action is to elicit a slot value from the user.
type
- The next action that the bot should take in its interaction with the user. The possible values are:
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be
fulfilled. This is a yes/no question such as "Place the order?"
Close
- Indicates that the there will not be a response from the user. For example, the
statement "Your order has been placed" does not require a response.
Delegate
- The next action is determined by Amazon Lex.
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill.
ElicitSlot
- The next action is to elicit a slot value from the user.
DialogActionType
public DialogAction withType(DialogActionType type)
The next action that the bot should take in its interaction with the user. The possible values are:
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be
fulfilled. This is a yes/no question such as "Place the order?"
Close
- Indicates that the there will not be a response from the user. For example, the statement
"Your order has been placed" does not require a response.
Delegate
- The next action is determined by Amazon Lex.
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill.
ElicitSlot
- The next action is to elicit a slot value from the user.
type
- The next action that the bot should take in its interaction with the user. The possible values are:
ConfirmIntent
- The next action is asking the user if the intent is complete and ready to be
fulfilled. This is a yes/no question such as "Place the order?"
Close
- Indicates that the there will not be a response from the user. For example, the
statement "Your order has been placed" does not require a response.
Delegate
- The next action is determined by Amazon Lex.
ElicitIntent
- The next action is to determine the intent that the user wants to fulfill.
ElicitSlot
- The next action is to elicit a slot value from the user.
DialogActionType
public void setIntentName(String intentName)
The name of the intent.
intentName
- The name of the intent.public String getIntentName()
The name of the intent.
public DialogAction withIntentName(String intentName)
The name of the intent.
intentName
- The name of the intent.public Map<String,String> getSlots()
Map of the slots that have been gathered and their values.
public void setSlots(Map<String,String> slots)
Map of the slots that have been gathered and their values.
slots
- Map of the slots that have been gathered and their values.public DialogAction withSlots(Map<String,String> slots)
Map of the slots that have been gathered and their values.
slots
- Map of the slots that have been gathered and their values.public DialogAction addSlotsEntry(String key, String value)
public DialogAction clearSlotsEntries()
public void setSlotToElicit(String slotToElicit)
The name of the slot that should be elicited from the user.
slotToElicit
- The name of the slot that should be elicited from the user.public String getSlotToElicit()
The name of the slot that should be elicited from the user.
public DialogAction withSlotToElicit(String slotToElicit)
The name of the slot that should be elicited from the user.
slotToElicit
- The name of the slot that should be elicited from the user.public void setFulfillmentState(String fulfillmentState)
The fulfillment state of the intent. The possible values are:
Failed
- The Lambda function associated with the intent failed to fulfill the intent.
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent.
ReadyForFulfillment
- All of the information necessary for the intent is present and the intent
ready to be fulfilled by the client application.
fulfillmentState
- The fulfillment state of the intent. The possible values are:
Failed
- The Lambda function associated with the intent failed to fulfill the intent.
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent.
ReadyForFulfillment
- All of the information necessary for the intent is present and the
intent ready to be fulfilled by the client application.
FulfillmentState
public String getFulfillmentState()
The fulfillment state of the intent. The possible values are:
Failed
- The Lambda function associated with the intent failed to fulfill the intent.
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent.
ReadyForFulfillment
- All of the information necessary for the intent is present and the intent
ready to be fulfilled by the client application.
Failed
- The Lambda function associated with the intent failed to fulfill the intent.
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent.
ReadyForFulfillment
- All of the information necessary for the intent is present and the
intent ready to be fulfilled by the client application.
FulfillmentState
public DialogAction withFulfillmentState(String fulfillmentState)
The fulfillment state of the intent. The possible values are:
Failed
- The Lambda function associated with the intent failed to fulfill the intent.
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent.
ReadyForFulfillment
- All of the information necessary for the intent is present and the intent
ready to be fulfilled by the client application.
fulfillmentState
- The fulfillment state of the intent. The possible values are:
Failed
- The Lambda function associated with the intent failed to fulfill the intent.
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent.
ReadyForFulfillment
- All of the information necessary for the intent is present and the
intent ready to be fulfilled by the client application.
FulfillmentState
public DialogAction withFulfillmentState(FulfillmentState fulfillmentState)
The fulfillment state of the intent. The possible values are:
Failed
- The Lambda function associated with the intent failed to fulfill the intent.
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent.
ReadyForFulfillment
- All of the information necessary for the intent is present and the intent
ready to be fulfilled by the client application.
fulfillmentState
- The fulfillment state of the intent. The possible values are:
Failed
- The Lambda function associated with the intent failed to fulfill the intent.
Fulfilled
- The intent has fulfilled by the Lambda function associated with the intent.
ReadyForFulfillment
- All of the information necessary for the intent is present and the
intent ready to be fulfilled by the client application.
FulfillmentState
public void setMessage(String message)
The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.
message
- The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the
message configured for the intent.public String getMessage()
The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.
public DialogAction withMessage(String message)
The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.
message
- The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the
message configured for the intent.public void setMessageFormat(String messageFormat)
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. For more
information, see Message
Groups.
messageFormat
-
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. For
more information, see Message Groups.
MessageFormatType
public String getMessageFormat()
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. For more
information, see Message
Groups.
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. For
more information, see Message Groups.
MessageFormatType
public DialogAction withMessageFormat(String messageFormat)
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. For more
information, see Message
Groups.
messageFormat
-
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. For
more information, see Message Groups.
MessageFormatType
public DialogAction withMessageFormat(MessageFormatType messageFormat)
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. For more
information, see Message
Groups.
messageFormat
-
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. For
more information, see Message Groups.
MessageFormatType
public String toString()
toString
in class Object
Object.toString()
public DialogAction clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.