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(value="software.amazon.awssdk:codegen")
public final class PutSlotTypeRequest
extends LexModelBuildingRequest
implements ToCopyableBuilder<PutSlotTypeRequest.Builder,PutSlotTypeRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutSlotTypeRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PutSlotTypeRequest.Builder	builder()
String	checksum() Identifies a specific revision of the $LATEST version.
Boolean	createVersion() When set to true a new numbered version of the slot type is created.
String	description() A description of the slot type.
List<EnumerationValue>	enumerationValues() A list of EnumerationValue objects that defines the values that the slot type can take.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEnumerationValues() For responses, this returns true if the service returned a value for the EnumerationValues property.
int	hashCode()
boolean	hasSlotTypeConfigurations() For responses, this returns true if the service returned a value for the SlotTypeConfigurations property.
String	name() The name of the slot type.
String	parentSlotTypeSignature() The built-in slot type used as the parent of the slot type.
List<SdkField<?>>	sdkFields()
static Class<? extends PutSlotTypeRequest.Builder>	serializableBuilderClass()
List<SlotTypeConfiguration>	slotTypeConfigurations() Configuration information that extends the parent built-in slot type.
PutSlotTypeRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
SlotValueSelectionStrategy	valueSelectionStrategy() Determines the slot resolution strategy that Amazon Lex uses to return slot type values.
String	valueSelectionStrategyAsString() Determines the slot resolution strategy that Amazon Lex uses to return slot type 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

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:

SlotValueSelectionStrategy

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:

SlotValueSelectionStrategy

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()

Specified by:

toBuilder in interface ToCopyableBuilder<PutSlotTypeRequest.Builder,PutSlotTypeRequest>

Specified by:

toBuilder in class LexModelBuildingRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo