Package software.amazon.awssdk.services.lexruntime.model

Class IntentSummary

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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<IntentSummary.Builder,IntentSummary>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.