Package software.amazon.awssdk.services.lexmodelbuilding.model

Class PutSlotTypeRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingRequest
software.amazon.awssdk.services.lexmodelbuilding.model.PutSlotTypeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutSlotTypeRequest.Builder,PutSlotTypeRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutSlotTypeRequest extends LexModelBuildingRequest implements ToCopyableBuilder<PutSlotTypeRequest.Builder,PutSlotTypeRequest>

  • Method Details

    • name

      public final String name()

      The name of the slot type. The name is not case sensitive.

      The name can't match a built-in slot type name, or a built-in slot type name with "AMAZON." removed. For example, because there is a built-in slot type called AMAZON.DATE, you can't create a custom slot type called DATE.

      For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.

      Returns:
      The name of the slot type. The name is not case sensitive.

      The name can't match a built-in slot type name, or a built-in slot type name with "AMAZON." removed. For example, because there is a built-in slot type called AMAZON.DATE, you can't create a custom slot type called DATE.

      For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.

    • description

      public final String description()

      A description of the slot type.

      Returns:
      A description of the slot type.

    • hasEnumerationValues

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

    • enumerationValues

      public final List<EnumerationValue> enumerationValues()

      A list of EnumerationValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, which are additional values that help train the machine learning model about the values that it resolves for a slot.

      A regular expression slot type doesn't require enumeration values. All other slot types require a list of enumeration values.

      When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not using a Lambda function you can choose to return the value that the user entered or the first value in the resolution list as the slot value. The valueSelectionStrategy field indicates the option to use.

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

      Returns:
      A list of EnumerationValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, which are additional values that help train the machine learning model about the values that it resolves for a slot.

      A regular expression slot type doesn't require enumeration values. All other slot types require a list of enumeration values.

      When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not using a Lambda function you can choose to return the value that the user entered or the first value in the resolution list as the slot value. The valueSelectionStrategy field indicates the option to use.

    • checksum

      public final String checksum()

      Identifies a specific revision of the $LATEST version.

      When you create a new slot type, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

      When you want to update a slot type, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

      Returns:
      Identifies a specific revision of the $LATEST version.

      When you create a new slot type, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

      When you want to update a slot type, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

    • valueSelectionStrategy

      public final SlotValueSelectionStrategy valueSelectionStrategy()

      Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:

      • ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value.

      • TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

      If you don't specify the valueSelectionStrategy, the default is ORIGINAL_VALUE.

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

      Returns:
      Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:

      • ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value.

      • TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

      If you don't specify the valueSelectionStrategy, the default is ORIGINAL_VALUE.

      See Also:

    • valueSelectionStrategyAsString

      public final String valueSelectionStrategyAsString()

      Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:

      • ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value.

      • TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

      If you don't specify the valueSelectionStrategy, the default is ORIGINAL_VALUE.

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

      Returns:
      Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:

      • ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value.

      • TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

      If you don't specify the valueSelectionStrategy, the default is ORIGINAL_VALUE.

      See Also:

    • createVersion

      public final Boolean createVersion()

      When set to true a new numbered version of the slot type is created. This is the same as calling the CreateSlotTypeVersion operation. If you do not specify createVersion, the default is false.

      Returns:
      When set to true a new numbered version of the slot type is created. This is the same as calling the CreateSlotTypeVersion operation. If you do not specify createVersion, the default is false.

    • parentSlotTypeSignature

      public final String parentSlotTypeSignature()

      The built-in slot type used as the parent of the slot type. When you define a parent slot type, the new slot type has all of the same configuration as the parent.

      Only AMAZON.AlphaNumeric is supported.

      Returns:
      The built-in slot type used as the parent of the slot type. When you define a parent slot type, the new slot type has all of the same configuration as the parent.

      Only AMAZON.AlphaNumeric is supported.

    • hasSlotTypeConfigurations

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

    • slotTypeConfigurations

      public final List<SlotTypeConfiguration> slotTypeConfigurations()

      Configuration information that extends the parent built-in slot type. The configuration is added to the settings for the parent slot type.

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

      Returns:
      Configuration information that extends the parent built-in slot type. The configuration is added to the settings for the parent slot type.

    • toBuilder

      public PutSlotTypeRequest.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<PutSlotTypeRequest.Builder,PutSlotTypeRequest>
      Specified by:
      toBuilder in class LexModelBuildingRequest
      Returns:
      a builder for type T

    • builder

      public static PutSlotTypeRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutSlotTypeRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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