IntentConfirmationSetting.Builder (AWS Java SDK :: Services

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 and Description
`IntentConfirmationSetting.Builder`	`active(Boolean active)` Specifies whether the intent's confirmation is sent to the user.
`default IntentConfirmationSetting.Builder`	`codeHook(Consumer<DialogCodeHookInvocationSetting.Builder> codeHook)` The `DialogCodeHookInvocationSetting` object associated with intent's confirmation step.
`IntentConfirmationSetting.Builder`	`codeHook(DialogCodeHookInvocationSetting codeHook)` The `DialogCodeHookInvocationSetting` object associated with intent's confirmation step.
`IntentConfirmationSetting.Builder`	`confirmationConditional(ConditionalSpecification confirmationConditional)` A list of conditional branches to evaluate after the intent is closed.
`default IntentConfirmationSetting.Builder`	`confirmationConditional(Consumer<ConditionalSpecification.Builder> confirmationConditional)` A list of conditional branches to evaluate after the intent is closed.
`default IntentConfirmationSetting.Builder`	`confirmationNextStep(Consumer<DialogState.Builder> confirmationNextStep)` Specifies the next step that the bot executes when the customer confirms the intent.
`IntentConfirmationSetting.Builder`	`confirmationNextStep(DialogState confirmationNextStep)` Specifies the next step that the bot executes when the customer confirms the intent.
`default IntentConfirmationSetting.Builder`	`confirmationResponse(Consumer<ResponseSpecification.Builder> confirmationResponse)` Sets the value of the ConfirmationResponse property for this object.
`IntentConfirmationSetting.Builder`	`confirmationResponse(ResponseSpecification confirmationResponse)` Sets the value of the ConfirmationResponse property for this object.
`IntentConfirmationSetting.Builder`	`declinationConditional(ConditionalSpecification declinationConditional)` A list of conditional branches to evaluate after the intent is declined.
`default IntentConfirmationSetting.Builder`	`declinationConditional(Consumer<ConditionalSpecification.Builder> declinationConditional)` A list of conditional branches to evaluate after the intent is declined.
`default IntentConfirmationSetting.Builder`	`declinationNextStep(Consumer<DialogState.Builder> declinationNextStep)` Specifies the next step that the bot executes when the customer declines the intent.
`IntentConfirmationSetting.Builder`	`declinationNextStep(DialogState declinationNextStep)` Specifies the next step that the bot executes when the customer declines the intent.
`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`	`elicitationCodeHook(Consumer<ElicitationCodeHookInvocationSetting.Builder> elicitationCodeHook)` The `DialogCodeHookInvocationSetting` used when the code hook is invoked during confirmation prompt retries.
`IntentConfirmationSetting.Builder`	`elicitationCodeHook(ElicitationCodeHookInvocationSetting elicitationCodeHook)` The `DialogCodeHookInvocationSetting` used when the code hook is invoked during confirmation prompt retries.
`IntentConfirmationSetting.Builder`	`failureConditional(ConditionalSpecification failureConditional)` Sets the value of the FailureConditional property for this object.
`default IntentConfirmationSetting.Builder`	`failureConditional(Consumer<ConditionalSpecification.Builder> failureConditional)` Sets the value of the FailureConditional property for this object.
`default IntentConfirmationSetting.Builder`	`failureNextStep(Consumer<DialogState.Builder> failureNextStep)` The next step to take in the conversation if the confirmation step fails.
`IntentConfirmationSetting.Builder`	`failureNextStep(DialogState failureNextStep)` The next step to take in the conversation if the confirmation step fails.
`default IntentConfirmationSetting.Builder`	`failureResponse(Consumer<ResponseSpecification.Builder> failureResponse)` Sets the value of the FailureResponse property for this object.
`IntentConfirmationSetting.Builder`	`failureResponse(ResponseSpecification failureResponse)` Sets the value of the FailureResponse property for this object.
`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 method 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 method 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.
  - 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 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 confirmationResponse(ResponseSpecification).
    
    Parameters:
    
    confirmationResponse - 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:
    
    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 the DialogState.Builder avoiding the need to create one manually via DialogState.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to confirmationNextStep(DialogState).
    
    Parameters:
    
    confirmationNextStep - a consumer that will call methods on DialogState.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 the ConditionalSpecification.Builder avoiding the need to create one manually via ConditionalSpecification.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to confirmationConditional(ConditionalSpecification).
    
    Parameters:
    
    confirmationConditional - a consumer that will call methods on ConditionalSpecification.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 the DialogState.Builder avoiding the need to create one manually via DialogState.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to declinationNextStep(DialogState).
    
    Parameters:
    
    declinationNextStep - a consumer that will call methods on DialogState.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 the ConditionalSpecification.Builder avoiding the need to create one manually via ConditionalSpecification.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to declinationConditional(ConditionalSpecification).
    
    Parameters:
    
    declinationConditional - a consumer that will call methods on ConditionalSpecification.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 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 failureResponse(ResponseSpecification).
    
    Parameters:
    
    failureResponse - 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:
    
    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 the DialogState.Builder avoiding the need to create one manually via DialogState.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to failureNextStep(DialogState).
    
    Parameters:
    
    failureNextStep - a consumer that will call methods on DialogState.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 the ConditionalSpecification.Builder avoiding the need to create one manually via ConditionalSpecification.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to failureConditional(ConditionalSpecification).
    
    Parameters:
    
    failureConditional - a consumer that will call methods on ConditionalSpecification.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 DialogCodeHookInvocationSetting object 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 is InvokeDialogCodeHook.
    
    Parameters:
    
    codeHook - The DialogCodeHookInvocationSetting object 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 is InvokeDialogCodeHook.
    
    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 DialogCodeHookInvocationSetting object 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 is InvokeDialogCodeHook.
    This is a convenience method that creates an instance of the DialogCodeHookInvocationSetting.Builder avoiding the need to create one manually via DialogCodeHookInvocationSetting.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to codeHook(DialogCodeHookInvocationSetting).
    
    Parameters:
    
    codeHook - a consumer that will call methods on DialogCodeHookInvocationSetting.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 DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.
    
    Parameters:
    
    elicitationCodeHook - The DialogCodeHookInvocationSetting used 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 DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.
    This is a convenience method that creates an instance of the ElicitationCodeHookInvocationSetting.Builder avoiding the need to create one manually via ElicitationCodeHookInvocationSetting.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to elicitationCodeHook(ElicitationCodeHookInvocationSetting).
    
    Parameters:
    
    elicitationCodeHook - a consumer that will call methods on ElicitationCodeHookInvocationSetting.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    elicitationCodeHook(ElicitationCodeHookInvocationSetting)

Interface IntentConfirmationSetting.Builder

Method Summary

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

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

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

Method Detail

promptSpecification

promptSpecification

declinationResponse

declinationResponse

active

confirmationResponse

confirmationResponse

confirmationNextStep

confirmationNextStep

confirmationConditional

confirmationConditional

declinationNextStep

declinationNextStep

declinationConditional

declinationConditional

failureResponse

failureResponse

failureNextStep

failureNextStep

failureConditional

failureConditional

codeHook

codeHook

elicitationCodeHook

elicitationCodeHook