Package software.amazon.awssdk.services.lexmodelsv2.model

Class CreateSlotRequest

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

  • Method Details

    • slotName

      public final String slotName()

      The name of the slot. Slot names must be unique within the bot that contains the slot.

      Returns:
      The name of the slot. Slot names must be unique within the bot that contains the slot.

    • description

      public final String description()

      A description of the slot. Use this to help identify the slot in lists.

      Returns:
      A description of the slot. Use this to help identify the slot in lists.

    • slotTypeId

      public final String slotTypeId()

      The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.

      Returns:
      The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.

    • valueElicitationSetting

      public final SlotValueElicitationSetting valueElicitationSetting()

      Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.

      Returns:
      Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.

    • obfuscationSetting

      public final ObfuscationSetting obfuscationSetting()

      Determines how slot values are used in Amazon CloudWatch logs. If the value of the obfuscationSetting parameter is DefaultObfuscation, slot values are obfuscated in the log output. If the value is None, the actual value is present in the log output.

      The default is to obfuscate values in the CloudWatch logs.

      Returns:
      Determines how slot values are used in Amazon CloudWatch logs. If the value of the obfuscationSetting parameter is DefaultObfuscation, slot values are obfuscated in the log output. If the value is None, the actual value is present in the log output.

      The default is to obfuscate values in the CloudWatch logs.

    • botId

      public final String botId()

      The identifier of the bot associated with the slot.

      Returns:
      The identifier of the bot associated with the slot.

    • botVersion

      public final String botVersion()

      The version of the bot associated with the slot.

      Returns:
      The version of the bot associated with the slot.

    • localeId

      public final String localeId()

      The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see Supported languages.

      Returns:
      The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see Supported languages.

    • intentId

      public final String intentId()

      The identifier of the intent that contains the slot.

      Returns:
      The identifier of the intent that contains the slot.

    • multipleValuesSetting

      public final MultipleValuesSetting multipleValuesSetting()

      Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

      If the multipleValuesSetting is not set, the default value is false.

      Returns:
      Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

      If the multipleValuesSetting is not set, the default value is false.

    • subSlotSetting

      public final SubSlotSetting subSlotSetting()

      Specifications for the constituent sub slots and the expression for the composite slot.

      Returns:
      Specifications for the constituent sub slots and the expression for the composite slot.

    • toBuilder

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

    • builder

      public static CreateSlotRequest.Builder builder()

    • serializableBuilderClass

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