Slot (AWS Java SDK :: Services :: Amazon Lex Model Building 2.17.218 API)

java.lang.Object
- software.amazon.awssdk.services.lexmodelbuilding.model.Slot

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Slot.Builder,Slot>

@Generated(value="software.amazon.awssdk:codegen")
public final class Slot
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Slot.Builder,Slot>

Identifies the version of a specific slot.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Slot.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Slot.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Slot.Builder`	`builder()`
`SlotDefaultValueSpec`	`defaultValueSpec()` A list of default values for the slot.
`String`	`description()` A description of the slot.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSampleUtterances()` For responses, this returns true if the service returned a value for the SampleUtterances property.
`String`	`name()` The name of the slot.
`ObfuscationSetting`	`obfuscationSetting()` Determines whether a slot is obfuscated in conversation logs and stored utterances.
`String`	`obfuscationSettingAsString()` Determines whether a slot is obfuscated in conversation logs and stored utterances.
`Integer`	`priority()` Directs Amazon Lex the order in which to elicit this slot value from the user.
`String`	`responseCard()` A set of possible responses for the slot type used by text-based clients.
`List<String>`	`sampleUtterances()` If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Slot.Builder>`	`serializableBuilderClass()`
`SlotConstraint`	`slotConstraint()` Specifies whether the slot is required or optional.
`String`	`slotConstraintAsString()` Specifies whether the slot is required or optional.
`String`	`slotType()` The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
`String`	`slotTypeVersion()` The version of the slot type.
`Slot.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Prompt`	`valueElicitationPrompt()` The prompt that Amazon Lex uses to elicit the slot value from the user.

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.
    
    Returns:
    
    The name of the slot.
  - description
```
public final String description()
```
    A description of the slot.
    
    Returns:
    
    A description of the slot.
  - slotConstraint
```
public final SlotConstraint slotConstraint()
```
    Specifies whether the slot is required or optional.
    
    If the service returns an enum value that is not available in the current SDK version, slotConstraint will return SlotConstraint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from slotConstraintAsString().
    
    Returns:
    
    Specifies whether the slot is required or optional.
    
    See Also:
    
    SlotConstraint
  - slotConstraintAsString
```
public final String slotConstraintAsString()
```
    Specifies whether the slot is required or optional.
    
    If the service returns an enum value that is not available in the current SDK version, slotConstraint will return SlotConstraint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from slotConstraintAsString().
    
    Returns:
    
    Specifies whether the slot is required or optional.
    
    See Also:
    
    SlotConstraint
  - slotType
```
public final String slotType()
```
    The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
    
    Returns:
    
    The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
  - slotTypeVersion
```
public final String slotTypeVersion()
```
    The version of the slot type.
    
    Returns:
    
    The version of the slot type.
  - valueElicitationPrompt
```
public final Prompt valueElicitationPrompt()
```
    The prompt that Amazon Lex uses to elicit the slot value from the user.
    
    Returns:
    
    The prompt that Amazon Lex uses to elicit the slot value from the user.
  - priority
```
public final Integer priority()
```
    Directs Amazon Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.
    
    If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.
    
    Returns:
    
    Directs Amazon Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.
    
    If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.
  - hasSampleUtterances
```
public final boolean hasSampleUtterances()
```
    For responses, this returns true if the service returned a value for the SampleUtterances 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.
  - sampleUtterances
```
public final List<String> sampleUtterances()
```
    If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.
    
    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 hasSampleUtterances() method.
    
    Returns:
    
    If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.
  - responseCard
```
public final String responseCard()
```
    A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.
    
    Returns:
    
    A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.
  - obfuscationSetting
```
public final ObfuscationSetting obfuscationSetting()
```
    Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is "full_name", obfuscated values are replaced with "{full_name}". For more information, see Slot Obfuscation .
    
    If the service returns an enum value that is not available in the current SDK version, obfuscationSetting will return ObfuscationSetting.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from obfuscationSettingAsString().
    
    Returns:
    
    Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is "full_name", obfuscated values are replaced with "{full_name}". For more information, see Slot Obfuscation .
    
    See Also:
    
    ObfuscationSetting
  - obfuscationSettingAsString
```
public final String obfuscationSettingAsString()
```
    Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is "full_name", obfuscated values are replaced with "{full_name}". For more information, see Slot Obfuscation .
    
    If the service returns an enum value that is not available in the current SDK version, obfuscationSetting will return ObfuscationSetting.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from obfuscationSettingAsString().
    
    Returns:
    
    Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is "full_name", obfuscated values are replaced with "{full_name}". For more information, see Slot Obfuscation .
    
    See Also:
    
    ObfuscationSetting
  - defaultValueSpec
```
public final SlotDefaultValueSpec defaultValueSpec()
```
    A list of default values for the slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.
    
    Returns:
    
    A list of default values for the slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.
  - toBuilder
```
public Slot.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Slot.Builder,Slot>
  - builder
```
public static Slot.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Slot.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)
```
    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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Slot

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

description

slotConstraint

slotConstraintAsString

slotType

slotTypeVersion

valueElicitationPrompt

priority

hasSampleUtterances

sampleUtterances

responseCard

obfuscationSetting

obfuscationSettingAsString

defaultValueSpec

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields