public class IntentSummary
extends java.lang.Object
implements java.io.Serializable
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(java.lang.String key,
java.lang.String value)
Map of the slots that have been gathered and their values.
|
IntentSummary |
clearslotsEntries()
Removes all the entries added into slots.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getCheckpointLabel()
A user-defined label that identifies a particular intent.
|
java.lang.String |
getConfirmationStatus()
The status of the intent after the user responds to the confirmation
prompt.
|
java.lang.String |
getDialogActionType()
The next action that the bot should take in its interaction with the
user.
|
java.lang.String |
getFulfillmentState()
The fulfillment state of the intent.
|
java.lang.String |
getIntentName()
The name of the intent.
|
java.util.Map<java.lang.String,java.lang.String> |
getSlots()
Map of the slots that have been gathered and their values.
|
java.lang.String |
getSlotToElicit()
The next slot to elicit from the user.
|
int |
hashCode() |
void |
setCheckpointLabel(java.lang.String checkpointLabel)
A user-defined label that identifies a particular intent.
|
void |
setConfirmationStatus(ConfirmationStatus confirmationStatus)
The status of the intent after the user responds to the confirmation
prompt.
|
void |
setConfirmationStatus(java.lang.String confirmationStatus)
The status of the intent after the user responds to the confirmation
prompt.
|
void |
setDialogActionType(DialogActionType dialogActionType)
The next action that the bot should take in its interaction with the
user.
|
void |
setDialogActionType(java.lang.String dialogActionType)
The next action that the bot should take in its interaction with the
user.
|
void |
setFulfillmentState(FulfillmentState fulfillmentState)
The fulfillment state of the intent.
|
void |
setFulfillmentState(java.lang.String fulfillmentState)
The fulfillment state of the intent.
|
void |
setIntentName(java.lang.String intentName)
The name of the intent.
|
void |
setSlots(java.util.Map<java.lang.String,java.lang.String> slots)
Map of the slots that have been gathered and their values.
|
void |
setSlotToElicit(java.lang.String slotToElicit)
The next slot to elicit from the user.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
IntentSummary |
withCheckpointLabel(java.lang.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(java.lang.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(java.lang.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(java.lang.String fulfillmentState)
The fulfillment state of the intent.
|
IntentSummary |
withIntentName(java.lang.String intentName)
The name of the intent.
|
IntentSummary |
withSlots(java.util.Map<java.lang.String,java.lang.String> slots)
Map of the slots that have been gathered and their values.
|
IntentSummary |
withSlotToElicit(java.lang.String slotToElicit)
The next slot to elicit from the user.
|
public java.lang.String getIntentName()
The name of the intent.
The name of the intent.
public void setIntentName(java.lang.String intentName)
The name of the intent.
intentName
- The name of the intent.
public IntentSummary withIntentName(java.lang.String intentName)
The name of the intent.
Returns a reference to this object so that method calls can be chained together.
intentName
- The name of the intent.
public java.lang.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.
Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9-]+
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 void setCheckpointLabel(java.lang.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.
Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9-]+
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 IntentSummary withCheckpointLabel(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9-]+
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 java.util.Map<java.lang.String,java.lang.String> getSlots()
Map of the slots that have been gathered and their values.
Map of the slots that have been gathered and their values.
public void setSlots(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.String> slots)
Map of the slots that have been gathered and their values.
Returns a reference to this object so that method calls can be chained together.
slots
- Map of the slots that have been gathered and their values.
public IntentSummary addslotsEntry(java.lang.String key, java.lang.String value)
Map of the slots that have been gathered and their values.
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.
key
- The key of the entry to be added into slots.value
- The corresponding value of the entry to be added into slots.public IntentSummary clearslotsEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.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.
Constraints:
Allowed Values: None, Confirmed, Denied
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 setConfirmationStatus(java.lang.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.
Constraints:
Allowed Values: None, Confirmed, Denied
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(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: None, Confirmed, Denied
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 setConfirmationStatus(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.
Constraints:
Allowed Values: None, Confirmed, Denied
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: None, Confirmed, Denied
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 java.lang.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.
Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Close,
Delegate
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 setDialogActionType(java.lang.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.
Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Close,
Delegate
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(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Close,
Delegate
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 setDialogActionType(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.
Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Close,
Delegate
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ElicitIntent, ConfirmIntent, ElicitSlot, Close,
Delegate
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 java.lang.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.
Constraints:
Allowed Values: Fulfilled, Failed, ReadyForFulfillment
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 setFulfillmentState(java.lang.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.
Constraints:
Allowed Values: Fulfilled, Failed, ReadyForFulfillment
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(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Fulfilled, Failed, ReadyForFulfillment
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 setFulfillmentState(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.
Constraints:
Allowed Values: Fulfilled, Failed, ReadyForFulfillment
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Fulfilled, Failed, ReadyForFulfillment
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 java.lang.String getSlotToElicit()
The next slot to elicit from the user. If there is not slot to elicit, the field is blank.
The next slot to elicit from the user. If there is not slot to elicit, the field is blank.
public void setSlotToElicit(java.lang.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 IntentSummary withSlotToElicit(java.lang.String slotToElicit)
The next slot to elicit from the user. If there is not slot to elicit, the field is blank.
Returns a reference to this object so that method calls can be chained together.
slotToElicit
- The next slot to elicit from the user. If there is not slot to elicit, the field is blank.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.