java.lang.Object
- software.amazon.awssdk.services.lexruntime.model.IntentSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IntentSummary.Builder,IntentSummary>
```
@Generated("software.amazon.awssdk:codegen")
public final class IntentSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IntentSummary.Builder,IntentSummary>
```
Provides information about the state of an intent. You can use this information to get the current state of an intent so that you can process the intent, or so that you can return the intent to its previous state.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface IntentSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static IntentSummary.Builder`	`builder()`
`String`	`checkpointLabel()`	A user-defined label that identifies a particular intent.
`ConfirmationStatus`	`confirmationStatus()`	The status of the intent after the user responds to the confirmation prompt.
`String`	`confirmationStatusAsString()`	The status of the intent after the user responds to the confirmation prompt.
`DialogActionType`	`dialogActionType()`	The next action that the bot should take in its interaction with the user.
`String`	`dialogActionTypeAsString()`	The next action that the bot should take in its interaction with the user.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FulfillmentState`	`fulfillmentState()`	The fulfillment state of the intent.
`String`	`fulfillmentStateAsString()`	The fulfillment state of the intent.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSlots()`	For responses, this returns true if the service returned a value for the Slots property.
`String`	`intentName()`	The name of the intent.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends IntentSummary.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`slots()`	Map of the slots that have been gathered and their values.
`String`	`slotToElicit()`	The next slot to elicit from the user.
`IntentSummary.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
  - intentName
```
public final String intentName()
```
    The name of the intent.
    
    Returns:
    
    The name of the intent.
  - checkpointLabel
```
public final String checkpointLabel()
```
    A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.
    
    Use the checkpointLabelFilter parameter of the GetSessionRequest operation to filter the intents returned by the operation to those with only the specified label.
    
    Returns:
    
    A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.
    
    Use the checkpointLabelFilter parameter of the GetSessionRequest operation to filter the intents returned by the operation to those with only the specified label.
  - hasSlots
```
public final boolean hasSlots()
```
    For responses, this returns true if the service returned a value for the Slots property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - slots
```
public final Map<String,String> slots()
```
    Map of the slots that have been gathered and their values.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSlots() method.
    
    Returns:
    
    Map of the slots that have been gathered and their values.
  - confirmationStatus
```
public final ConfirmationStatus confirmationStatus()
```
    The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:
    
    Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.
    
    Denied - The user has responded "No" to the confirmation prompt.
    
    None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.
    
    If the service returns an enum value that is not available in the current SDK version, confirmationStatus will return ConfirmationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from confirmationStatusAsString().
    Returns:
    
    The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:
    
    Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.
    
    Denied - The user has responded "No" to the confirmation prompt.
    
    None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.
    
    See Also:
    
    ConfirmationStatus
  - confirmationStatusAsString
```
public final String confirmationStatusAsString()
```
    The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:
    
    Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.
    
    Denied - The user has responded "No" to the confirmation prompt.
    
    None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.
    
    If the service returns an enum value that is not available in the current SDK version, confirmationStatus will return ConfirmationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from confirmationStatusAsString().
    Returns:
    
    The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:
    
    Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.
    
    Denied - The user has responded "No" to the confirmation prompt.
    
    None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.
    
    See Also:
    
    ConfirmationStatus
  - dialogActionType
```
public final DialogActionType dialogActionType()
```
    The next action that the bot should take in its interaction with the user. The possible values are:
    
    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?"
    
    Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
    
    ElicitIntent - The next action is to determine the intent that the user wants to fulfill.
    
    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, dialogActionType will return DialogActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dialogActionTypeAsString().
    Returns:
    
    The next action that the bot should take in its interaction with the user. The possible values are:
    
    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?"
    
    Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
    
    ElicitIntent - The next action is to determine the intent that the user wants to fulfill.
    
    ElicitSlot - The next action is to elicit a slot value from the user.
    
    See Also:
    
    DialogActionType
  - dialogActionTypeAsString
```
public final String dialogActionTypeAsString()
```
    The next action that the bot should take in its interaction with the user. The possible values are:
    
    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?"
    
    Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
    
    ElicitIntent - The next action is to determine the intent that the user wants to fulfill.
    
    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, dialogActionType will return DialogActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dialogActionTypeAsString().
    Returns:
    
    The next action that the bot should take in its interaction with the user. The possible values are:
    
    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?"
    
    Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
    
    ElicitIntent - The next action is to determine the intent that the user wants to fulfill.
    
    ElicitSlot - The next action is to elicit a slot value from the user.
    
    See Also:
    
    DialogActionType
  - fulfillmentState
```
public final FulfillmentState fulfillmentState()
```
    The fulfillment state of the intent. The possible values are:
    
    Failed - The Lambda function associated with the intent failed to fulfill the intent.
    
    Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.
    
    ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.
    
    If the service returns an enum value that is not available in the current SDK version, fulfillmentState will return FulfillmentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fulfillmentStateAsString().
    Returns:
    
    The fulfillment state of the intent. The possible values are:
    
    Failed - The Lambda function associated with the intent failed to fulfill the intent.
    
    Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.
    
    ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.
    
    See Also:
    
    FulfillmentState
  - fulfillmentStateAsString
```
public final String fulfillmentStateAsString()
```
    The fulfillment state of the intent. The possible values are:
    
    Failed - The Lambda function associated with the intent failed to fulfill the intent.
    
    Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.
    
    ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.
    
    If the service returns an enum value that is not available in the current SDK version, fulfillmentState will return FulfillmentState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fulfillmentStateAsString().
    Returns:
    
    The fulfillment state of the intent. The possible values are:
    
    Failed - The Lambda function associated with the intent failed to fulfill the intent.
    
    Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.
    
    ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.
    
    See Also:
    
    FulfillmentState
  - slotToElicit
```
public final String slotToElicit()
```
    The next slot to elicit from the user. If there is not slot to elicit, the field is blank.
    
    Returns:
    
    The next slot to elicit from the user. If there is not slot to elicit, the field is blank.
  - toBuilder
```
public IntentSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<IntentSummary.Builder,IntentSummary>
  - builder
```
public static IntentSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends IntentSummary.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 IntentSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

intentName

checkpointLabel

hasSlots

slots

confirmationStatus

confirmationStatusAsString

dialogActionType

dialogActionTypeAsString

fulfillmentState

fulfillmentStateAsString

slotToElicit

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields