Class CreateSlotTypeRequest
- 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.CreateSlotTypeRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateSlotTypeRequest.Builder,CreateSlotTypeRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateSlotTypeRequest extends LexModelsV2Request implements ToCopyableBuilder<CreateSlotTypeRequest.Builder,CreateSlotTypeRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateSlotTypeRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringbotId()The identifier of the bot associated with this slot type.StringbotVersion()The identifier of the bot version associated with this slot type.static CreateSlotTypeRequest.Builderbuilder()CompositeSlotTypeSettingcompositeSlotTypeSetting()Specifications for a composite slot type.Stringdescription()A description of the slot type.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)ExternalSourceSettingexternalSourceSetting()Sets the type of external information used to create the slot type.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasSlotTypeValues()For responses, this returns true if the service returned a value for the SlotTypeValues property.StringlocaleId()The identifier of the language and locale that the slot type will be used in.StringparentSlotTypeSignature()The built-in slot type used as a parent of this slot type.List<SdkField<?>>sdkFields()static Class<? extends CreateSlotTypeRequest.Builder>serializableBuilderClass()StringslotTypeName()The name for the slot.List<SlotTypeValue>slotTypeValues()A list ofSlotTypeValueobjects that defines the values that the slot type can take.CreateSlotTypeRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.SlotValueSelectionSettingvalueSelectionSetting()Determines the strategy that Amazon Lex uses to select a value from the list of possible values.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
slotTypeName
public final String slotTypeName()
The name for the slot. A slot type name must be unique within the intent.
- Returns:
- The name for the slot. A slot type name must be unique within the intent.
-
description
public final String description()
A description of the slot type. Use the description to help identify the slot type in lists.
- Returns:
- A description of the slot type. Use the description to help identify the slot type in lists.
-
hasSlotTypeValues
public final boolean hasSlotTypeValues()
For responses, this returns true if the service returned a value for the SlotTypeValues property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
slotTypeValues
public final List<SlotTypeValue> slotTypeValues()
A list of
SlotTypeValueobjects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.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
hasSlotTypeValues()method.- Returns:
- A list of
SlotTypeValueobjects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.
-
valueSelectionSetting
public final SlotValueSelectionSetting valueSelectionSetting()
Determines the strategy that Amazon Lex uses to select a value from the list of possible 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. If there is no resolution list, return null.
If you don't specify the
valueSelectionSettingparameter, the default isORIGINAL_VALUE.- Returns:
- Determines the strategy that Amazon Lex uses to select a value from the list of possible 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. If there is no resolution list, return null.
If you don't specify the
valueSelectionSettingparameter, the default isORIGINAL_VALUE. -
-
-
parentSlotTypeSignature
public final String parentSlotTypeSignature()
The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.
Only
AMAZON.AlphaNumericis supported.- Returns:
- The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new
slot type has the configuration of the parent slot type.
Only
AMAZON.AlphaNumericis supported.
-
botId
public final String botId()
The identifier of the bot associated with this slot type.
- Returns:
- The identifier of the bot associated with this slot type.
-
botVersion
public final String botVersion()
The identifier of the bot version associated with this slot type.
- Returns:
- The identifier of the bot version associated with this slot type.
-
localeId
public final String localeId()
The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see Supported languages.
- Returns:
- The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see Supported languages.
-
externalSourceSetting
public final ExternalSourceSetting externalSourceSetting()
Sets the type of external information used to create the slot type.
- Returns:
- Sets the type of external information used to create the slot type.
-
compositeSlotTypeSetting
public final CompositeSlotTypeSetting compositeSlotTypeSetting()
Specifications for a composite slot type.
- Returns:
- Specifications for a composite slot type.
-
toBuilder
public CreateSlotTypeRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateSlotTypeRequest.Builder,CreateSlotTypeRequest>- Specified by:
toBuilderin classLexModelsV2Request
-
builder
public static CreateSlotTypeRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateSlotTypeRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-