Intent (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Intent
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The current intent that Amazon Lex V2 is attempting to fulfill.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Intent()

Constructors
Constructor and Description
`Intent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Intent`	`addSlotsEntry(String key, Slot value)` Add a single Slots entry
`Intent`	`clearSlotsEntries()` Removes all the entries added into Slots.
`Intent`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getConfirmationState()` Indicates whether the intent has been `Confirmed`, `Denied`, or `None` if the confirmation stage has not yet been reached.
`String`	`getName()` The name of the intent.
`Map<String,Slot>`	`getSlots()` A map of all of the slots for the intent.
`String`	`getState()` Indicates the fulfillment state for the intent.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setConfirmationState(String confirmationState)` Indicates whether the intent has been `Confirmed`, `Denied`, or `None` if the confirmation stage has not yet been reached.
`void`	`setName(String name)` The name of the intent.
`void`	`setSlots(Map<String,Slot> slots)` A map of all of the slots for the intent.
`void`	`setState(String state)` Indicates the fulfillment state for the intent.
`String`	`toString()` Returns a string representation of this object.
`Intent`	`withConfirmationState(ConfirmationState confirmationState)` Indicates whether the intent has been `Confirmed`, `Denied`, or `None` if the confirmation stage has not yet been reached.
`Intent`	`withConfirmationState(String confirmationState)` Indicates whether the intent has been `Confirmed`, `Denied`, or `None` if the confirmation stage has not yet been reached.
`Intent`	`withName(String name)` The name of the intent.
`Intent`	`withSlots(Map<String,Slot> slots)` A map of all of the slots for the intent.
`Intent`	`withState(IntentState state)` Indicates the fulfillment state for the intent.
`Intent`	`withState(String state)` Indicates the fulfillment state for the intent.

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

- Constructor Detail
  - Intent
```
public Intent()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the intent.
    
    Parameters:
    
    name - The name of the intent.
  - getName
```
public String getName()
```
    The name of the intent.
    
    Returns:
    
    The name of the intent.
  - withName
```
public Intent withName(String name)
```
    The name of the intent.
    
    Parameters:
    
    name - The name of the intent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSlots
```
public Map<String,Slot> getSlots()
```
    A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.
    
    Returns:
    
    A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.
  - setSlots
```
public void setSlots(Map<String,Slot> slots)
```
    A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.
    
    Parameters:
    
    slots - A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.
  - withSlots
```
public Intent withSlots(Map<String,Slot> slots)
```
    A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.
    
    Parameters:
    
    slots - A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addSlotsEntry
```
public Intent addSlotsEntry(String key,
                            Slot value)
```
    Add a single Slots entry
    
    See Also:
    
    withSlots(java.util.Map<java.lang.String, com.amazonaws.services.lexruntimev2.model.Slot>)
  - clearSlotsEntries
```
public Intent clearSlotsEntries()
```
    Removes all the entries added into Slots.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    Indicates the fulfillment state for the intent. The meanings of each value are as follows:
    - Failed – The bot failed to fulfill the intent.
    - Fulfilled – The bot has completed fulfillment of the intent.
    - FulfillmentInProgress – The bot is in the middle of fulfilling the intent.
    - InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.
    - ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.
    - Waiting – The bot is waiting for a response from the user (limited to streaming conversations).
    Parameters:
    state - Indicates the fulfillment state for the intent. The meanings of each value are as follows:
    
    Failed – The bot failed to fulfill the intent.
    
    Fulfilled – The bot has completed fulfillment of the intent.
    
    FulfillmentInProgress – The bot is in the middle of fulfilling the intent.
    
    InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.
    
    ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.
    
    Waiting – The bot is waiting for a response from the user (limited to streaming conversations).
    See Also:
    
    IntentState
  - getState
```
public String getState()
```
    Indicates the fulfillment state for the intent. The meanings of each value are as follows:
    - Failed – The bot failed to fulfill the intent.
    - Fulfilled – The bot has completed fulfillment of the intent.
    - FulfillmentInProgress – The bot is in the middle of fulfilling the intent.
    - InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.
    - ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.
    - Waiting – The bot is waiting for a response from the user (limited to streaming conversations).
    Returns:
    Indicates the fulfillment state for the intent. The meanings of each value are as follows:
    
    Failed – The bot failed to fulfill the intent.
    
    Fulfilled – The bot has completed fulfillment of the intent.
    
    FulfillmentInProgress – The bot is in the middle of fulfilling the intent.
    
    InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.
    
    ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.
    
    Waiting – The bot is waiting for a response from the user (limited to streaming conversations).
    See Also:
    
    IntentState
  - withState
```
public Intent withState(String state)
```
    Indicates the fulfillment state for the intent. The meanings of each value are as follows:
    - Failed – The bot failed to fulfill the intent.
    - Fulfilled – The bot has completed fulfillment of the intent.
    - FulfillmentInProgress – The bot is in the middle of fulfilling the intent.
    - InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.
    - ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.
    - Waiting – The bot is waiting for a response from the user (limited to streaming conversations).
    Parameters:
    state - Indicates the fulfillment state for the intent. The meanings of each value are as follows:
    
    Failed – The bot failed to fulfill the intent.
    
    Fulfilled – The bot has completed fulfillment of the intent.
    
    FulfillmentInProgress – The bot is in the middle of fulfilling the intent.
    
    InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.
    
    ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.
    
    Waiting – The bot is waiting for a response from the user (limited to streaming conversations).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IntentState
  - withState
```
public Intent withState(IntentState state)
```
    Indicates the fulfillment state for the intent. The meanings of each value are as follows:
    - Failed – The bot failed to fulfill the intent.
    - Fulfilled – The bot has completed fulfillment of the intent.
    - FulfillmentInProgress – The bot is in the middle of fulfilling the intent.
    - InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.
    - ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.
    - Waiting – The bot is waiting for a response from the user (limited to streaming conversations).
    Parameters:
    state - Indicates the fulfillment state for the intent. The meanings of each value are as follows:
    
    Failed – The bot failed to fulfill the intent.
    
    Fulfilled – The bot has completed fulfillment of the intent.
    
    FulfillmentInProgress – The bot is in the middle of fulfilling the intent.
    
    InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.
    
    ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.
    
    Waiting – The bot is waiting for a response from the user (limited to streaming conversations).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IntentState
  - setConfirmationState
```
public void setConfirmationState(String confirmationState)
```
    Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.
    
    Parameters:
    
    confirmationState - Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.
    
    See Also:
    
    ConfirmationState
  - getConfirmationState
```
public String getConfirmationState()
```
    Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.
    
    Returns:
    
    Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.
    
    See Also:
    
    ConfirmationState
  - withConfirmationState
```
public Intent withConfirmationState(String confirmationState)
```
    Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.
    
    Parameters:
    
    confirmationState - Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConfirmationState
  - withConfirmationState
```
public Intent withConfirmationState(ConfirmationState confirmationState)
```
    Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.
    
    Parameters:
    
    confirmationState - Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConfirmationState
  - 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 Intent 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.792

Class Intent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Intent

Method Detail

setName

getName

withName

getSlots

setSlots

withSlots

addSlotsEntry

clearSlotsEntries

setState

getState

withState

withState

setConfirmationState

getConfirmationState

withConfirmationState

withConfirmationState

toString

equals

hashCode

clone

marshall