Class Value

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

Information about the value provided for a slot and Amazon Lex V2's interpretation.

See Also:

  • Method Details

    • originalValue

      public final String originalValue()

      The part of the user's response to the slot elicitation that Amazon Lex V2 determines is relevant to the slot value.

      Returns:
      The part of the user's response to the slot elicitation that Amazon Lex V2 determines is relevant to the slot value.

    • interpretedValue

      public final String interpretedValue()

      The value that Amazon Lex V2 determines for the slot, given the user input. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex V2 choose the first value in the resolvedValues list.

      Returns:
      The value that Amazon Lex V2 determines for the slot, given the user input. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex V2 choose the first value in the resolvedValues list.

    • hasResolvedValues

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

    • resolvedValues

      public final List<String> resolvedValues()

      A list of values that Amazon Lex V2 determines are possible resolutions for the user input. The first value matches the interpretedValue.

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

      Returns:
      A list of values that Amazon Lex V2 determines are possible resolutions for the user input. The first value matches the interpretedValue.

    • toBuilder

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

    • builder

      public static Value.Builder builder()

    • serializableBuilderClass

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