software.amazon.awssdk.services.lexmodelsv2.model

Interface IntentConfirmationSetting.Builder

All Superinterfaces:

Buildable, CopyableBuilder<IntentConfirmationSetting.Builder,IntentConfirmationSetting>, SdkBuilder<IntentConfirmationSetting.Builder,IntentConfirmationSetting>, SdkPojo

Enclosing class:

IntentConfirmationSetting

public static interface IntentConfirmationSetting.Builder
extends SdkPojo, CopyableBuilder<IntentConfirmationSetting.Builder,IntentConfirmationSetting>

Method Summary

Modifier and Type	Method and Description
IntentConfirmationSetting.Builder	active(Boolean active) Specifies whether the intent's confirmation is sent to the user.
default IntentConfirmationSetting.Builder	declinationResponse(Consumer<ResponseSpecification.Builder> 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.Builder	declinationResponse(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.
default IntentConfirmationSetting.Builder	promptSpecification(Consumer<PromptSpecification.Builder> promptSpecification) Prompts the user to confirm the intent.
IntentConfirmationSetting.Builder	promptSpecification(PromptSpecification promptSpecification) Prompts the user to confirm the intent.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

promptSpecification

IntentConfirmationSetting.Builder promptSpecification(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.

promptSpecification

default IntentConfirmationSetting.Builder promptSpecification(Consumer<PromptSpecification.Builder> 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.

This is a convenience that creates an instance of the PromptSpecification.Builder avoiding the need to create one manually via PromptSpecification.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to promptSpecification(PromptSpecification).

Parameters:

promptSpecification - a consumer that will call methods on PromptSpecification.Builder

Returns:

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

See Also:

promptSpecification(PromptSpecification)

declinationResponse

IntentConfirmationSetting.Builder declinationResponse(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.

declinationResponse

default IntentConfirmationSetting.Builder declinationResponse(Consumer<ResponseSpecification.Builder> 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.

This is a convenience that creates an instance of the ResponseSpecification.Builder avoiding the need to create one manually via ResponseSpecification.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to declinationResponse(ResponseSpecification).

Parameters:

declinationResponse - a consumer that will call methods on ResponseSpecification.Builder

Returns:

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

See Also:

declinationResponse(ResponseSpecification)

active

IntentConfirmationSetting.Builder active(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.