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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description IntentConfirmationSetting.Builderactive(Boolean active)Specifies whether the intent's confirmation is sent to the user.default IntentConfirmationSetting.BuildercodeHook(Consumer<DialogCodeHookInvocationSetting.Builder> codeHook)TheDialogCodeHookInvocationSettingobject associated with intent's confirmation step.IntentConfirmationSetting.BuildercodeHook(DialogCodeHookInvocationSetting codeHook)TheDialogCodeHookInvocationSettingobject associated with intent's confirmation step.default IntentConfirmationSetting.BuilderconfirmationConditional(Consumer<ConditionalSpecification.Builder> confirmationConditional)A list of conditional branches to evaluate after the intent is closed.IntentConfirmationSetting.BuilderconfirmationConditional(ConditionalSpecification confirmationConditional)A list of conditional branches to evaluate after the intent is closed.default IntentConfirmationSetting.BuilderconfirmationNextStep(Consumer<DialogState.Builder> confirmationNextStep)Specifies the next step that the bot executes when the customer confirms the intent.IntentConfirmationSetting.BuilderconfirmationNextStep(DialogState confirmationNextStep)Specifies the next step that the bot executes when the customer confirms the intent.default IntentConfirmationSetting.BuilderconfirmationResponse(Consumer<ResponseSpecification.Builder> confirmationResponse)Sets the value of the ConfirmationResponse property for this object.IntentConfirmationSetting.BuilderconfirmationResponse(ResponseSpecification confirmationResponse)Sets the value of the ConfirmationResponse property for this object.default IntentConfirmationSetting.BuilderdeclinationConditional(Consumer<ConditionalSpecification.Builder> declinationConditional)A list of conditional branches to evaluate after the intent is declined.IntentConfirmationSetting.BuilderdeclinationConditional(ConditionalSpecification declinationConditional)A list of conditional branches to evaluate after the intent is declined.default IntentConfirmationSetting.BuilderdeclinationNextStep(Consumer<DialogState.Builder> declinationNextStep)Specifies the next step that the bot executes when the customer declines the intent.IntentConfirmationSetting.BuilderdeclinationNextStep(DialogState declinationNextStep)Specifies the next step that the bot executes when the customer declines the intent.default IntentConfirmationSetting.BuilderdeclinationResponse(Consumer<ResponseSpecification.Builder> declinationResponse)When the user answers "no" to the question defined inpromptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.IntentConfirmationSetting.BuilderdeclinationResponse(ResponseSpecification declinationResponse)When the user answers "no" to the question defined inpromptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.default IntentConfirmationSetting.BuilderelicitationCodeHook(Consumer<ElicitationCodeHookInvocationSetting.Builder> elicitationCodeHook)TheDialogCodeHookInvocationSettingused when the code hook is invoked during confirmation prompt retries.IntentConfirmationSetting.BuilderelicitationCodeHook(ElicitationCodeHookInvocationSetting elicitationCodeHook)TheDialogCodeHookInvocationSettingused when the code hook is invoked during confirmation prompt retries.default IntentConfirmationSetting.BuilderfailureConditional(Consumer<ConditionalSpecification.Builder> failureConditional)Sets the value of the FailureConditional property for this object.IntentConfirmationSetting.BuilderfailureConditional(ConditionalSpecification failureConditional)Sets the value of the FailureConditional property for this object.default IntentConfirmationSetting.BuilderfailureNextStep(Consumer<DialogState.Builder> failureNextStep)The next step to take in the conversation if the confirmation step fails.IntentConfirmationSetting.BuilderfailureNextStep(DialogState failureNextStep)The next step to take in the conversation if the confirmation step fails.default IntentConfirmationSetting.BuilderfailureResponse(Consumer<ResponseSpecification.Builder> failureResponse)Sets the value of the FailureResponse property for this object.IntentConfirmationSetting.BuilderfailureResponse(ResponseSpecification failureResponse)Sets the value of the FailureResponse property for this object.default IntentConfirmationSetting.BuilderpromptSpecification(Consumer<PromptSpecification.Builder> promptSpecification)Prompts the user to confirm the intent.IntentConfirmationSetting.BuilderpromptSpecification(PromptSpecification promptSpecification)Prompts the user to confirm the intent.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
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
OrderPizzaintent, 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
OrderPizzaintent, 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
This is a convenience method that creates an instance of theOrderPizzaintent, 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.PromptSpecification.Builderavoiding the need to create one manually viaPromptSpecification.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed topromptSpecification(PromptSpecification).- Parameters:
promptSpecification- a consumer that will call methods onPromptSpecification.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 inpromptSpecification, 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
This is a convenience method that creates an instance of thepromptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.ResponseSpecification.Builderavoiding the need to create one manually viaResponseSpecification.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todeclinationResponse(ResponseSpecification).- Parameters:
declinationResponse- a consumer that will call methods onResponseSpecification.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
activefield 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 theactivefield isn't specified, the default is true.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
confirmationResponse
IntentConfirmationSetting.Builder confirmationResponse(ResponseSpecification confirmationResponse)
Sets the value of the ConfirmationResponse property for this object.- Parameters:
confirmationResponse- The new value for the ConfirmationResponse property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
confirmationResponse
default IntentConfirmationSetting.Builder confirmationResponse(Consumer<ResponseSpecification.Builder> confirmationResponse)
Sets the value of the ConfirmationResponse property for this object. This is a convenience method that creates an instance of theResponseSpecification.Builderavoiding the need to create one manually viaResponseSpecification.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toconfirmationResponse(ResponseSpecification).- Parameters:
confirmationResponse- a consumer that will call methods onResponseSpecification.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
confirmationResponse(ResponseSpecification)
-
confirmationNextStep
IntentConfirmationSetting.Builder confirmationNextStep(DialogState confirmationNextStep)
Specifies the next step that the bot executes when the customer confirms the intent.
- Parameters:
confirmationNextStep- Specifies the next step that the bot executes when the customer confirms the intent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
confirmationNextStep
default IntentConfirmationSetting.Builder confirmationNextStep(Consumer<DialogState.Builder> confirmationNextStep)
Specifies the next step that the bot executes when the customer confirms the intent.
This is a convenience method that creates an instance of theDialogState.Builderavoiding the need to create one manually viaDialogState.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toconfirmationNextStep(DialogState).- Parameters:
confirmationNextStep- a consumer that will call methods onDialogState.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
confirmationNextStep(DialogState)
-
confirmationConditional
IntentConfirmationSetting.Builder confirmationConditional(ConditionalSpecification confirmationConditional)
A list of conditional branches to evaluate after the intent is closed.
- Parameters:
confirmationConditional- A list of conditional branches to evaluate after the intent is closed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
confirmationConditional
default IntentConfirmationSetting.Builder confirmationConditional(Consumer<ConditionalSpecification.Builder> confirmationConditional)
A list of conditional branches to evaluate after the intent is closed.
This is a convenience method that creates an instance of theConditionalSpecification.Builderavoiding the need to create one manually viaConditionalSpecification.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toconfirmationConditional(ConditionalSpecification).- Parameters:
confirmationConditional- a consumer that will call methods onConditionalSpecification.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
confirmationConditional(ConditionalSpecification)
-
declinationNextStep
IntentConfirmationSetting.Builder declinationNextStep(DialogState declinationNextStep)
Specifies the next step that the bot executes when the customer declines the intent.
- Parameters:
declinationNextStep- Specifies the next step that the bot executes when the customer declines the intent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
declinationNextStep
default IntentConfirmationSetting.Builder declinationNextStep(Consumer<DialogState.Builder> declinationNextStep)
Specifies the next step that the bot executes when the customer declines the intent.
This is a convenience method that creates an instance of theDialogState.Builderavoiding the need to create one manually viaDialogState.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todeclinationNextStep(DialogState).- Parameters:
declinationNextStep- a consumer that will call methods onDialogState.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
declinationNextStep(DialogState)
-
declinationConditional
IntentConfirmationSetting.Builder declinationConditional(ConditionalSpecification declinationConditional)
A list of conditional branches to evaluate after the intent is declined.
- Parameters:
declinationConditional- A list of conditional branches to evaluate after the intent is declined.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
declinationConditional
default IntentConfirmationSetting.Builder declinationConditional(Consumer<ConditionalSpecification.Builder> declinationConditional)
A list of conditional branches to evaluate after the intent is declined.
This is a convenience method that creates an instance of theConditionalSpecification.Builderavoiding the need to create one manually viaConditionalSpecification.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todeclinationConditional(ConditionalSpecification).- Parameters:
declinationConditional- a consumer that will call methods onConditionalSpecification.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
declinationConditional(ConditionalSpecification)
-
failureResponse
IntentConfirmationSetting.Builder failureResponse(ResponseSpecification failureResponse)
Sets the value of the FailureResponse property for this object.- Parameters:
failureResponse- The new value for the FailureResponse property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failureResponse
default IntentConfirmationSetting.Builder failureResponse(Consumer<ResponseSpecification.Builder> failureResponse)
Sets the value of the FailureResponse property for this object. This is a convenience method that creates an instance of theResponseSpecification.Builderavoiding the need to create one manually viaResponseSpecification.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofailureResponse(ResponseSpecification).- Parameters:
failureResponse- a consumer that will call methods onResponseSpecification.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
failureResponse(ResponseSpecification)
-
failureNextStep
IntentConfirmationSetting.Builder failureNextStep(DialogState failureNextStep)
The next step to take in the conversation if the confirmation step fails.
- Parameters:
failureNextStep- The next step to take in the conversation if the confirmation step fails.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failureNextStep
default IntentConfirmationSetting.Builder failureNextStep(Consumer<DialogState.Builder> failureNextStep)
The next step to take in the conversation if the confirmation step fails.
This is a convenience method that creates an instance of theDialogState.Builderavoiding the need to create one manually viaDialogState.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofailureNextStep(DialogState).- Parameters:
failureNextStep- a consumer that will call methods onDialogState.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
failureNextStep(DialogState)
-
failureConditional
IntentConfirmationSetting.Builder failureConditional(ConditionalSpecification failureConditional)
Sets the value of the FailureConditional property for this object.- Parameters:
failureConditional- The new value for the FailureConditional property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
failureConditional
default IntentConfirmationSetting.Builder failureConditional(Consumer<ConditionalSpecification.Builder> failureConditional)
Sets the value of the FailureConditional property for this object. This is a convenience method that creates an instance of theConditionalSpecification.Builderavoiding the need to create one manually viaConditionalSpecification.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofailureConditional(ConditionalSpecification).- Parameters:
failureConditional- a consumer that will call methods onConditionalSpecification.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
failureConditional(ConditionalSpecification)
-
codeHook
IntentConfirmationSetting.Builder codeHook(DialogCodeHookInvocationSetting codeHook)
The
DialogCodeHookInvocationSettingobject associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step isInvokeDialogCodeHook.- Parameters:
codeHook- TheDialogCodeHookInvocationSettingobject associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step isInvokeDialogCodeHook.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
codeHook
default IntentConfirmationSetting.Builder codeHook(Consumer<DialogCodeHookInvocationSetting.Builder> codeHook)
The
This is a convenience method that creates an instance of theDialogCodeHookInvocationSettingobject associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step isInvokeDialogCodeHook.DialogCodeHookInvocationSetting.Builderavoiding the need to create one manually viaDialogCodeHookInvocationSetting.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocodeHook(DialogCodeHookInvocationSetting).- Parameters:
codeHook- a consumer that will call methods onDialogCodeHookInvocationSetting.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
codeHook(DialogCodeHookInvocationSetting)
-
elicitationCodeHook
IntentConfirmationSetting.Builder elicitationCodeHook(ElicitationCodeHookInvocationSetting elicitationCodeHook)
The
DialogCodeHookInvocationSettingused when the code hook is invoked during confirmation prompt retries.- Parameters:
elicitationCodeHook- TheDialogCodeHookInvocationSettingused when the code hook is invoked during confirmation prompt retries.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
elicitationCodeHook
default IntentConfirmationSetting.Builder elicitationCodeHook(Consumer<ElicitationCodeHookInvocationSetting.Builder> elicitationCodeHook)
The
This is a convenience method that creates an instance of theDialogCodeHookInvocationSettingused when the code hook is invoked during confirmation prompt retries.ElicitationCodeHookInvocationSetting.Builderavoiding the need to create one manually viaElicitationCodeHookInvocationSetting.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toelicitationCodeHook(ElicitationCodeHookInvocationSetting).- Parameters:
elicitationCodeHook- a consumer that will call methods onElicitationCodeHookInvocationSetting.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
elicitationCodeHook(ElicitationCodeHookInvocationSetting)
-
-