DialogAction (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lexruntimev2.model.DialogAction

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DialogAction
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The next action that Amazon Lex V2 should take.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DialogAction()

Constructors
Constructor and Description
`DialogAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DialogAction`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getSlotElicitationStyle()` Configures the slot to use spell-by-letter or spell-by-word style.
`String`	`getSlotToElicit()` The name of the slot that should be elicited from the user.
`ElicitSubSlot`	`getSubSlotToElicit()` The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.
`String`	`getType()` The next action that the bot should take in its interaction with the user.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setSlotElicitationStyle(String slotElicitationStyle)` Configures the slot to use spell-by-letter or spell-by-word style.
`void`	`setSlotToElicit(String slotToElicit)` The name of the slot that should be elicited from the user.
`void`	`setSubSlotToElicit(ElicitSubSlot subSlotToElicit)` The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.
`void`	`setType(String type)` The next action that the bot should take in its interaction with the user.
`String`	`toString()` Returns a string representation of this object.
`DialogAction`	`withSlotElicitationStyle(String slotElicitationStyle)` Configures the slot to use spell-by-letter or spell-by-word style.
`DialogAction`	`withSlotElicitationStyle(StyleType slotElicitationStyle)` Configures the slot to use spell-by-letter or spell-by-word style.
`DialogAction`	`withSlotToElicit(String slotToElicit)` The name of the slot that should be elicited from the user.
`DialogAction`	`withSubSlotToElicit(ElicitSubSlot subSlotToElicit)` The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.
`DialogAction`	`withType(DialogActionType type)` The next action that the bot should take in its interaction with the user.
`DialogAction`	`withType(String type)` The next action that the bot should take in its interaction with the user.

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

- Constructor Detail
  - DialogAction
```
public DialogAction()
```
- Method Detail
  - setType
```
public void setType(String 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.
    Parameters:
    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.
    See Also:
    
    DialogActionType
  - getType
```
public String getType()
```
    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.
    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
  - withType
```
public DialogAction withType(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DialogActionType
  - withType
```
public DialogAction withType(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DialogActionType
  - setSlotToElicit
```
public void setSlotToElicit(String slotToElicit)
```
    The name of the slot that should be elicited from the user.
    
    Parameters:
    
    slotToElicit - The name of the slot that should be elicited from the user.
  - getSlotToElicit
```
public String getSlotToElicit()
```
    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.
  - withSlotToElicit
```
public DialogAction withSlotToElicit(String slotToElicit)
```
    The name of the slot that should be elicited from the user.
    
    Parameters:
    
    slotToElicit - The name of the slot that should be elicited from the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSlotElicitationStyle
```
public void setSlotElicitationStyle(String 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 .
    Parameters:
    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 .
    See Also:
    
    StyleType
  - getSlotElicitationStyle
```
public String getSlotElicitationStyle()
```
    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 .
    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
  - withSlotElicitationStyle
```
public DialogAction withSlotElicitationStyle(String 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 .
    Parameters:
    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 .
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StyleType
  - withSlotElicitationStyle
```
public DialogAction withSlotElicitationStyle(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 .
    Parameters:
    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 .
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StyleType
  - setSubSlotToElicit
```
public void setSubSlotToElicit(ElicitSubSlot subSlotToElicit)
```
    The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.
    
    Parameters:
    
    subSlotToElicit - The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.
  - getSubSlotToElicit
```
public ElicitSubSlot getSubSlotToElicit()
```
    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.
  - withSubSlotToElicit
```
public DialogAction withSubSlotToElicit(ElicitSubSlot subSlotToElicit)
```
    The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.
    
    Parameters:
    
    subSlotToElicit - The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DialogAction clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.485

Class DialogAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DialogAction

Method Detail

setType

getType

withType

withType

setSlotToElicit

getSlotToElicit

withSlotToElicit

setSlotElicitationStyle

getSlotElicitationStyle

withSlotElicitationStyle

withSlotElicitationStyle

setSubSlotToElicit

getSubSlotToElicit

withSubSlotToElicit

toString

equals

hashCode

clone

marshall