Class Intent
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Intent.Builder,
Intent>
The current intent that Amazon Lex V2 is attempting to fulfill.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Intent.Builder
builder()
final ConfirmationState
Indicates whether the intent has beenConfirmed
,Denied
, orNone
if the confirmation stage has not yet been reached.final String
Indicates whether the intent has beenConfirmed
,Denied
, orNone
if the confirmation stage has not yet been reached.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasSlots()
For responses, this returns true if the service returned a value for the Slots property.final String
name()
The name of the intent.static Class
<? extends Intent.Builder> slots()
A map of all of the slots for the intent.final IntentState
state()
Indicates the fulfillment state for the intent.final String
Indicates the fulfillment state for the intent.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the intent.
- Returns:
- The name of the intent.
-
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 theisEmpty()
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
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.
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:
- 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.
-
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).
If the service returns an enum value that is not available in the current SDK version,
state
will returnIntentState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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:
-
-
stateAsString
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).
If the service returns an enum value that is not available in the current SDK version,
state
will returnIntentState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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:
-
-
confirmationState
Indicates whether the intent has been
Confirmed
,Denied
, orNone
if the confirmation stage has not yet been reached.If the service returns an enum value that is not available in the current SDK version,
confirmationState
will returnConfirmationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconfirmationStateAsString()
.- Returns:
- Indicates whether the intent has been
Confirmed
,Denied
, orNone
if the confirmation stage has not yet been reached. - See Also:
-
confirmationStateAsString
Indicates whether the intent has been
Confirmed
,Denied
, orNone
if the confirmation stage has not yet been reached.If the service returns an enum value that is not available in the current SDK version,
confirmationState
will returnConfirmationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconfirmationStateAsString()
.- Returns:
- Indicates whether the intent has been
Confirmed
,Denied
, orNone
if the confirmation stage has not yet been reached. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Intent.Builder,
Intent> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-