com.amazonaws.services.lexmodelsv2.model

Class IntentConfirmationSetting

java.lang.Object

com.amazonaws.services.lexmodelsv2.model.IntentConfirmationSetting

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IntentConfirmationSetting
extends Object
implements Serializable, Cloneable, StructuredPojo

Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IntentConfirmationSetting()

Method Summary

Modifier and Type	Method and Description
IntentConfirmationSetting	clone()
boolean	equals(Object obj)
Boolean	getActive() Specifies whether the intent's confirmation is sent to the user.
ResponseSpecification	getDeclinationResponse() When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.
PromptSpecification	getPromptSpecification() Prompts the user to confirm the intent.
int	hashCode()
Boolean	isActive() Specifies whether the intent's confirmation is sent to the user.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setActive(Boolean active) Specifies whether the intent's confirmation is sent to the user.
void	setDeclinationResponse(ResponseSpecification declinationResponse) When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.
void	setPromptSpecification(PromptSpecification promptSpecification) Prompts the user to confirm the intent.
String	toString() Returns a string representation of this object.
IntentConfirmationSetting	withActive(Boolean active) Specifies whether the intent's confirmation is sent to the user.
IntentConfirmationSetting	withDeclinationResponse(ResponseSpecification declinationResponse) When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.
IntentConfirmationSetting	withPromptSpecification(PromptSpecification promptSpecification) Prompts the user to confirm the intent.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IntentConfirmationSetting

public IntentConfirmationSetting()

Method Detail

setPromptSpecification

public void setPromptSpecification(PromptSpecification promptSpecification)

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

Parameters:

promptSpecification - Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

getPromptSpecification

public PromptSpecification getPromptSpecification()

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

Returns:

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

withPromptSpecification

public IntentConfirmationSetting withPromptSpecification(PromptSpecification promptSpecification)

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

Parameters:

promptSpecification - Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDeclinationResponse

public void setDeclinationResponse(ResponseSpecification declinationResponse)

When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

Parameters:

declinationResponse - When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

getDeclinationResponse

public ResponseSpecification getDeclinationResponse()

When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

Returns:

When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

withDeclinationResponse

public IntentConfirmationSetting withDeclinationResponse(ResponseSpecification declinationResponse)

When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

Parameters:

declinationResponse - When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

Returns:

Returns a reference to this object so that method calls can be chained together.

setActive

public void setActive(Boolean active)

Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

Parameters:

active - Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

getActive

public Boolean getActive()

Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

Returns:

Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

withActive

public IntentConfirmationSetting withActive(Boolean active)

Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

Parameters:

active - Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

Returns:

Returns a reference to this object so that method calls can be chained together.

isActive

public Boolean isActive()

Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

Returns:

Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public IntentConfirmationSetting clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.