IntentConfirmationSetting (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.lexmodelsv2.model.IntentConfirmationSetting

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IntentConfirmationSetting.Builder,IntentConfirmationSetting>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class IntentConfirmationSetting
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IntentConfirmationSetting.Builder,IntentConfirmationSetting>
```
Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface IntentConfirmationSetting.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`IntentConfirmationSetting.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`active()` Specifies whether the intent's confirmation is sent to the user.
`static IntentConfirmationSetting.Builder`	`builder()`
`DialogCodeHookInvocationSetting`	`codeHook()` The `DialogCodeHookInvocationSetting` object associated with intent's confirmation step.
`ConditionalSpecification`	`confirmationConditional()` A list of conditional branches to evaluate after the intent is closed.
`DialogState`	`confirmationNextStep()` Specifies the next step that the bot executes when the customer confirms the intent.
`ResponseSpecification`	`confirmationResponse()` Returns the value of the ConfirmationResponse property for this object.
`ConditionalSpecification`	`declinationConditional()` A list of conditional branches to evaluate after the intent is declined.
`DialogState`	`declinationNextStep()` Specifies the next step that the bot executes when the customer declines the intent.
`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.
`ElicitationCodeHookInvocationSetting`	`elicitationCodeHook()` The `DialogCodeHookInvocationSetting` used when the code hook is invoked during confirmation prompt retries.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ConditionalSpecification`	`failureConditional()` Returns the value of the FailureConditional property for this object.
`DialogState`	`failureNextStep()` The next step to take in the conversation if the confirmation step fails.
`ResponseSpecification`	`failureResponse()` Returns the value of the FailureResponse property for this object.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`PromptSpecification`	`promptSpecification()` Prompts the user to confirm the intent.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends IntentConfirmationSetting.Builder>`	`serializableBuilderClass()`
`IntentConfirmationSetting.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - promptSpecification
```
public final 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.
    
    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.
  - declinationResponse
```
public final 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.
    
    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.
  - active
```
public final 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.
    
    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.
  - confirmationResponse
```
public final ResponseSpecification confirmationResponse()
```
    Returns the value of the ConfirmationResponse property for this object.
    
    Returns:
    
    The value of the ConfirmationResponse property for this object.
  - confirmationNextStep
```
public final DialogState confirmationNextStep()
```
    Specifies the next step that the bot executes when the customer confirms the intent.
    
    Returns:
    
    Specifies the next step that the bot executes when the customer confirms the intent.
  - confirmationConditional
```
public final ConditionalSpecification confirmationConditional()
```
    A list of conditional branches to evaluate after the intent is closed.
    
    Returns:
    
    A list of conditional branches to evaluate after the intent is closed.
  - declinationNextStep
```
public final DialogState declinationNextStep()
```
    Specifies the next step that the bot executes when the customer declines the intent.
    
    Returns:
    
    Specifies the next step that the bot executes when the customer declines the intent.
  - declinationConditional
```
public final ConditionalSpecification declinationConditional()
```
    A list of conditional branches to evaluate after the intent is declined.
    
    Returns:
    
    A list of conditional branches to evaluate after the intent is declined.
  - failureResponse
```
public final ResponseSpecification failureResponse()
```
    Returns the value of the FailureResponse property for this object.
    
    Returns:
    
    The value of the FailureResponse property for this object.
  - failureNextStep
```
public final DialogState failureNextStep()
```
    The next step to take in the conversation if the confirmation step fails.
    
    Returns:
    
    The next step to take in the conversation if the confirmation step fails.
  - failureConditional
```
public final ConditionalSpecification failureConditional()
```
    Returns the value of the FailureConditional property for this object.
    
    Returns:
    
    The value of the FailureConditional property for this object.
  - codeHook
```
public final 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.
    
    Returns:
    
    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.
  - elicitationCodeHook
```
public final ElicitationCodeHookInvocationSetting elicitationCodeHook()
```
    The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.
    
    Returns:
    
    The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.
  - toBuilder
```
public IntentConfirmationSetting.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<IntentConfirmationSetting.Builder,IntentConfirmationSetting>
  - builder
```
public static IntentConfirmationSetting.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends IntentConfirmationSetting.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class IntentConfirmationSetting

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

promptSpecification

declinationResponse

active

confirmationResponse

confirmationNextStep

confirmationConditional

declinationNextStep

declinationConditional

failureResponse

failureNextStep

failureConditional

codeHook

elicitationCodeHook

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields