Class SubSlotValueElicitationSetting

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

Subslot elicitation settings.

DefaultValueSpecification is a list of default values for a constituent sub slot in a composite slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values. This is similar to DefaultValueSpecification for slots.

PromptSpecification is the prompt that Amazon Lex uses to elicit the sub slot value from the user. This is similar to PromptSpecification for slots.

See Also:

  • Method Details

    • defaultValueSpecification

      public final SlotDefaultValueSpecification defaultValueSpecification()
      Returns the value of the DefaultValueSpecification property for this object.
      Returns:
      The value of the DefaultValueSpecification property for this object.

    • promptSpecification

      public final PromptSpecification promptSpecification()
      Returns the value of the PromptSpecification property for this object.
      Returns:
      The value of the PromptSpecification property for this object.

    • hasSampleUtterances

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

    • sampleUtterances

      public final List<SampleUtterance> sampleUtterances()

      If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to SampleUtterances for slots.

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

      Returns:
      If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to SampleUtterances for slots.

    • waitAndContinueSpecification

      public final WaitAndContinueSpecification waitAndContinueSpecification()
      Returns the value of the WaitAndContinueSpecification property for this object.
      Returns:
      The value of the WaitAndContinueSpecification property for this object.

    • toBuilder

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

    • builder

      public static SubSlotValueElicitationSetting.Builder builder()

    • serializableBuilderClass

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