Class IntentSummary

java.lang.Object
software.amazon.awssdk.services.lexmodelsv2.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>

Summary information about an intent returned by the ListIntents operation.

See Also:

  • Method Details

    • intentId

      public final String intentId()

      The unique identifier assigned to the intent. Use this ID to get detailed information about the intent with the DescribeIntent operation.

      Returns:
      The unique identifier assigned to the intent. Use this ID to get detailed information about the intent with the DescribeIntent operation.

    • intentName

      public final String intentName()

      The name of the intent.

      Returns:
      The name of the intent.

    • description

      public final String description()

      The description of the intent.

      Returns:
      The description of the intent.

    • parentIntentSignature

      public final String parentIntentSignature()

      If this intent is derived from a built-in intent, the name of the parent intent.

      Returns:
      If this intent is derived from a built-in intent, the name of the parent intent.

    • hasInputContexts

      public final boolean hasInputContexts()
      For responses, this returns true if the service returned a value for the InputContexts 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.

    • inputContexts

      public final List<InputContext> inputContexts()

      The input contexts that must be active for this intent to be considered for recognition.

      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 hasInputContexts() method.

      Returns:
      The input contexts that must be active for this intent to be considered for recognition.

    • hasOutputContexts

      public final boolean hasOutputContexts()
      For responses, this returns true if the service returned a value for the OutputContexts 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.

    • outputContexts

      public final List<OutputContext> outputContexts()

      The output contexts that are activated when this intent is fulfilled.

      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 hasOutputContexts() method.

      Returns:
      The output contexts that are activated when this intent is fulfilled.

    • lastUpdatedDateTime

      public final Instant lastUpdatedDateTime()

      The timestamp of the date and time that the intent was last updated.

      Returns:
      The timestamp of the date and time that the intent was last updated.

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