DialogAction (AWS Java SDK :: Services :: Lex Runtime V2 2.19.0 API)

java.lang.Object
- software.amazon.awssdk.services.lexruntimev2.model.DialogAction

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DialogAction.Builder,DialogAction>

@Generated(value="software.amazon.awssdk:codegen")
public final class DialogAction
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DialogAction.Builder,DialogAction>

The next action that Amazon Lex V2 should take.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DialogAction.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DialogAction.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DialogAction.Builder>`	`serializableBuilderClass()`
`StyleType`	`slotElicitationStyle()` Configures the slot to use spell-by-letter or spell-by-word style.
`String`	`slotElicitationStyleAsString()` Configures the slot to use spell-by-letter or spell-by-word style.
`String`	`slotToElicit()` The name of the slot that should be elicited from the user.
`ElicitSubSlot`	`subSlotToElicit()` The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.
`DialogAction.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`DialogActionType`	`type()` The next action that the bot should take in its interaction with the user.
`String`	`typeAsString()` The next action that the bot should take in its interaction with the user.

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
  - type
```
public final DialogActionType type()
```
    The next action that the bot should take in its interaction with the user. The possible values are:
    - Close - Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
    - ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"
    - Delegate - The next action is determined by Amazon Lex V2.
    - ElicitIntent - The next action is to elicit an intent from the user.
    - ElicitSlot - The next action is to elicit a slot value from the user.
    If the service returns an enum value that is not available in the current SDK version, type will return DialogActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    Returns:
    The next action that the bot should take in its interaction with the user. The possible values are:
    
    Close - Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
    
    ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"
    
    Delegate - The next action is determined by Amazon Lex V2.
    
    ElicitIntent - The next action is to elicit an intent from the user.
    
    ElicitSlot - The next action is to elicit a slot value from the user.
    See Also:
    
    DialogActionType
  - typeAsString
```
public final String typeAsString()
```
    The next action that the bot should take in its interaction with the user. The possible values are:
    - Close - Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
    - ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"
    - Delegate - The next action is determined by Amazon Lex V2.
    - ElicitIntent - The next action is to elicit an intent from the user.
    - ElicitSlot - The next action is to elicit a slot value from the user.
    If the service returns an enum value that is not available in the current SDK version, type will return DialogActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    Returns:
    The next action that the bot should take in its interaction with the user. The possible values are:
    
    Close - Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
    
    ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"
    
    Delegate - The next action is determined by Amazon Lex V2.
    
    ElicitIntent - The next action is to elicit an intent from the user.
    
    ElicitSlot - The next action is to elicit a slot value from the user.
    See Also:
    
    DialogActionType
  - slotToElicit
```
public final String slotToElicit()
```
    The name of the slot that should be elicited from the user.
    
    Returns:
    
    The name of the slot that should be elicited from the user.
  - slotElicitationStyle
```
public final StyleType slotElicitationStyle()
```
    Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.
    - Spell by letter - "b" "o" "b"
    - Spell by word - "b as in boy" "o as in oscar" "b as in boy"
    For more information, see Using spelling to enter slot values .
    
    If the service returns an enum value that is not available in the current SDK version, slotElicitationStyle will return StyleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from slotElicitationStyleAsString().
    Returns:
    Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.
    
    Spell by letter - "b" "o" "b"
    
    Spell by word - "b as in boy" "o as in oscar" "b as in boy"
    
    For more information, see Using spelling to enter slot values .
    See Also:
    
    StyleType
  - slotElicitationStyleAsString
```
public final String slotElicitationStyleAsString()
```
    Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.
    - Spell by letter - "b" "o" "b"
    - Spell by word - "b as in boy" "o as in oscar" "b as in boy"
    For more information, see Using spelling to enter slot values .
    
    If the service returns an enum value that is not available in the current SDK version, slotElicitationStyle will return StyleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from slotElicitationStyleAsString().
    Returns:
    Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.
    
    Spell by letter - "b" "o" "b"
    
    Spell by word - "b as in boy" "o as in oscar" "b as in boy"
    
    For more information, see Using spelling to enter slot values .
    See Also:
    
    StyleType
  - subSlotToElicit
```
public final ElicitSubSlot subSlotToElicit()
```
    The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.
    
    Returns:
    
    The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.
  - toBuilder
```
public DialogAction.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DialogAction.Builder,DialogAction>
  - builder
```
public static DialogAction.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DialogAction.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 DialogAction

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

type

typeAsString

slotToElicit

slotElicitationStyle

slotElicitationStyleAsString

subSlotToElicit

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields