Class SlotSummary

java.lang.Object
software.amazon.awssdk.services.lexmodelsv2.model.SlotSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SlotSummary.Builder,SlotSummary>
@Generated("software.amazon.awssdk:codegen") public final class SlotSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SlotSummary.Builder,SlotSummary>

Summary information about a slot, a value that the bot elicits from the user.

See Also:

  • Method Details

    • slotId

      public final String slotId()

      The unique identifier of the slot.

      Returns:
      The unique identifier of the slot.

    • slotName

      public final String slotName()

      The name given to the slot.

      Returns:
      The name given to the slot.

    • description

      public final String description()

      The description of the slot.

      Returns:
      The description of the slot.

    • slotConstraint

      public final SlotConstraint slotConstraint()

      Whether the slot is required or optional. An intent is complete when all required slots are filled.

      If the service returns an enum value that is not available in the current SDK version, slotConstraint will return SlotConstraint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from slotConstraintAsString().

      Returns:
      Whether the slot is required or optional. An intent is complete when all required slots are filled.
      See Also:

    • slotConstraintAsString

      public final String slotConstraintAsString()

      Whether the slot is required or optional. An intent is complete when all required slots are filled.

      If the service returns an enum value that is not available in the current SDK version, slotConstraint will return SlotConstraint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from slotConstraintAsString().

      Returns:
      Whether the slot is required or optional. An intent is complete when all required slots are filled.
      See Also:

    • slotTypeId

      public final String slotTypeId()

      The unique identifier for the slot type that defines the values for the slot.

      Returns:
      The unique identifier for the slot type that defines the values for the slot.

    • valueElicitationPromptSpecification

      public final PromptSpecification valueElicitationPromptSpecification()

      Prompts that are sent to the user to elicit a value for the slot.

      Returns:
      Prompts that are sent to the user to elicit a value for the slot.

    • lastUpdatedDateTime

      public final Instant lastUpdatedDateTime()

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

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

    • toBuilder

      public SlotSummary.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<SlotSummary.Builder,SlotSummary>
      Returns:
      a builder for type T

    • builder

      public static SlotSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SlotSummary.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.