@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class IntentSummary extends Object implements Serializable, Cloneable, StructuredPojo
Provides information about the state of an intent. You can use this information to get the current state of an intent so that you can process the intent, or so that you can return the intent to its previous state.
Constructor and Description |
---|
IntentSummary() |
Modifier and Type | Method and Description |
---|---|
IntentSummary |
addSlotsEntry(String key,
String value)
Add a single Slots entry
|
IntentSummary |
clearSlotsEntries()
Removes all the entries added into Slots.
|
IntentSummary |
clone() |
boolean |
equals(Object obj) |
String |
getCheckpointLabel()
A user-defined label that identifies a particular intent.
|
String |
getConfirmationStatus()
The status of the intent after the user responds to the confirmation prompt.
|
String |
getDialogActionType()
The next action that the bot should take in its interaction with the user.
|
String |
getFulfillmentState()
The fulfillment state of the intent.
|
String |
getIntentName()
The name of the intent.
|
Map<String,String> |
getSlots()
Map of the slots that have been gathered and their values.
|
String |
getSlotToElicit()
The next slot to elicit from the user.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCheckpointLabel(String checkpointLabel)
A user-defined label that identifies a particular intent.
|
void |
setConfirmationStatus(String confirmationStatus)
The status of the intent after the user responds to the confirmation prompt.
|
void |
setDialogActionType(String dialogActionType)
The next action that the bot should take in its interaction with the user.
|
void |
setFulfillmentState(String fulfillmentState)
The fulfillment state of the intent.
|
void |
setIntentName(String intentName)
The name of the intent.
|
void |
setSlots(Map<String,String> slots)
Map of the slots that have been gathered and their values.
|
void |
setSlotToElicit(String slotToElicit)
The next slot to elicit from the user.
|
String |
toString()
Returns a string representation of this object.
|
IntentSummary |
withCheckpointLabel(String checkpointLabel)
A user-defined label that identifies a particular intent.
|
IntentSummary |
withConfirmationStatus(ConfirmationStatus confirmationStatus)
The status of the intent after the user responds to the confirmation prompt.
|
IntentSummary |
withConfirmationStatus(String confirmationStatus)
The status of the intent after the user responds to the confirmation prompt.
|
IntentSummary |
withDialogActionType(DialogActionType dialogActionType)
The next action that the bot should take in its interaction with the user.
|
IntentSummary |
withDialogActionType(String dialogActionType)
The next action that the bot should take in its interaction with the user.
|
IntentSummary |
withFulfillmentState(FulfillmentState fulfillmentState)
The fulfillment state of the intent.
|
IntentSummary |
withFulfillmentState(String fulfillmentState)
The fulfillment state of the intent.
|
IntentSummary |
withIntentName(String intentName)
The name of the intent.
|
IntentSummary |
withSlots(Map<String,String> slots)
Map of the slots that have been gathered and their values.
|
IntentSummary |
withSlotToElicit(String slotToElicit)
The next slot to elicit from the user.
|
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 IntentSummary withIntentName(String intentName)
The name of the intent.
intentName
- The name of the intent.public void setCheckpointLabel(String checkpointLabel)
A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.
Use the checkpointLabelFilter
parameter of the GetSessionRequest
operation to filter
the intents returned by the operation to those with only the specified label.
checkpointLabel
- A user-defined label that identifies a particular intent. You can use this label to return to a previous
intent.
Use the checkpointLabelFilter
parameter of the GetSessionRequest
operation to
filter the intents returned by the operation to those with only the specified label.
public String getCheckpointLabel()
A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.
Use the checkpointLabelFilter
parameter of the GetSessionRequest
operation to filter
the intents returned by the operation to those with only the specified label.
Use the checkpointLabelFilter
parameter of the GetSessionRequest
operation to
filter the intents returned by the operation to those with only the specified label.
public IntentSummary withCheckpointLabel(String checkpointLabel)
A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.
Use the checkpointLabelFilter
parameter of the GetSessionRequest
operation to filter
the intents returned by the operation to those with only the specified label.
checkpointLabel
- A user-defined label that identifies a particular intent. You can use this label to return to a previous
intent.
Use the checkpointLabelFilter
parameter of the GetSessionRequest
operation to
filter the intents returned by the operation to those with only the specified label.
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 IntentSummary 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 IntentSummary addSlotsEntry(String key, String value)
public IntentSummary clearSlotsEntries()
public void setConfirmationStatus(String confirmationStatus)
The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent,
Amazon Lex sets this field to Confirmed
. If the user denies the intent, Amazon Lex sets this value
to Denied
. The possible values are:
Confirmed
- The user has responded "Yes" to the confirmation prompt, confirming that the intent is
complete and that it is ready to be fulfilled.
Denied
- The user has responded "No" to the confirmation prompt.
None
- The user has never been prompted for confirmation; or, the user was prompted but did not
confirm or deny the prompt.
confirmationStatus
- The status of the intent after the user responds to the confirmation prompt. If the user confirms the
intent, Amazon Lex sets this field to Confirmed
. If the user denies the intent, Amazon Lex
sets this value to Denied
. The possible values are:
Confirmed
- The user has responded "Yes" to the confirmation prompt, confirming that the
intent is complete and that it is ready to be fulfilled.
Denied
- The user has responded "No" to the confirmation prompt.
None
- The user has never been prompted for confirmation; or, the user was prompted but did
not confirm or deny the prompt.
ConfirmationStatus
public String getConfirmationStatus()
The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent,
Amazon Lex sets this field to Confirmed
. If the user denies the intent, Amazon Lex sets this value
to Denied
. The possible values are:
Confirmed
- The user has responded "Yes" to the confirmation prompt, confirming that the intent is
complete and that it is ready to be fulfilled.
Denied
- The user has responded "No" to the confirmation prompt.
None
- The user has never been prompted for confirmation; or, the user was prompted but did not
confirm or deny the prompt.
Confirmed
. If the user denies the intent, Amazon Lex
sets this value to Denied
. The possible values are:
Confirmed
- The user has responded "Yes" to the confirmation prompt, confirming that the
intent is complete and that it is ready to be fulfilled.
Denied
- The user has responded "No" to the confirmation prompt.
None
- The user has never been prompted for confirmation; or, the user was prompted but did
not confirm or deny the prompt.
ConfirmationStatus
public IntentSummary withConfirmationStatus(String confirmationStatus)
The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent,
Amazon Lex sets this field to Confirmed
. If the user denies the intent, Amazon Lex sets this value
to Denied
. The possible values are:
Confirmed
- The user has responded "Yes" to the confirmation prompt, confirming that the intent is
complete and that it is ready to be fulfilled.
Denied
- The user has responded "No" to the confirmation prompt.
None
- The user has never been prompted for confirmation; or, the user was prompted but did not
confirm or deny the prompt.
confirmationStatus
- The status of the intent after the user responds to the confirmation prompt. If the user confirms the
intent, Amazon Lex sets this field to Confirmed
. If the user denies the intent, Amazon Lex
sets this value to Denied
. The possible values are:
Confirmed
- The user has responded "Yes" to the confirmation prompt, confirming that the
intent is complete and that it is ready to be fulfilled.
Denied
- The user has responded "No" to the confirmation prompt.
None
- The user has never been prompted for confirmation; or, the user was prompted but did
not confirm or deny the prompt.
ConfirmationStatus
public IntentSummary withConfirmationStatus(ConfirmationStatus confirmationStatus)
The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent,
Amazon Lex sets this field to Confirmed
. If the user denies the intent, Amazon Lex sets this value
to Denied
. The possible values are:
Confirmed
- The user has responded "Yes" to the confirmation prompt, confirming that the intent is
complete and that it is ready to be fulfilled.
Denied
- The user has responded "No" to the confirmation prompt.
None
- The user has never been prompted for confirmation; or, the user was prompted but did not
confirm or deny the prompt.
confirmationStatus
- The status of the intent after the user responds to the confirmation prompt. If the user confirms the
intent, Amazon Lex sets this field to Confirmed
. If the user denies the intent, Amazon Lex
sets this value to Denied
. The possible values are:
Confirmed
- The user has responded "Yes" to the confirmation prompt, confirming that the
intent is complete and that it is ready to be fulfilled.
Denied
- The user has responded "No" to the confirmation prompt.
None
- The user has never been prompted for confirmation; or, the user was prompted but did
not confirm or deny the prompt.
ConfirmationStatus
public void setDialogActionType(String dialogActionType)
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.
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
- 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.
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 getDialogActionType()
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.
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.
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 IntentSummary withDialogActionType(String dialogActionType)
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.
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
- 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.
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 IntentSummary withDialogActionType(DialogActionType dialogActionType)
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.
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
- 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.
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 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 IntentSummary 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 IntentSummary 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 setSlotToElicit(String slotToElicit)
The next slot to elicit from the user. If there is not slot to elicit, the field is blank.
slotToElicit
- The next slot to elicit from the user. If there is not slot to elicit, the field is blank.public String getSlotToElicit()
The next slot to elicit from the user. If there is not slot to elicit, the field is blank.
public IntentSummary withSlotToElicit(String slotToElicit)
The next slot to elicit from the user. If there is not slot to elicit, the field is blank.
slotToElicit
- The next slot to elicit from the user. If there is not slot to elicit, the field is blank.public String toString()
toString
in class Object
Object.toString()
public IntentSummary clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.