Slot (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lexmodelbuilding.model.Slot

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Slot
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Identifies the version of a specific slot.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Slot()

Constructors
Constructor and Description
`Slot()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Slot`	`clone()`
`boolean`	`equals(Object obj)`
`SlotDefaultValueSpec`	`getDefaultValueSpec()` A list of default values for the slot.
`String`	`getDescription()` A description of the slot.
`String`	`getName()` The name of the slot.
`String`	`getObfuscationSetting()` Determines whether a slot is obfuscated in conversation logs and stored utterances.
`Integer`	`getPriority()` Directs Amazon Lex the order in which to elicit this slot value from the user.
`String`	`getResponseCard()` A set of possible responses for the slot type used by text-based clients.
`List<String>`	`getSampleUtterances()` 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.
`String`	`getSlotConstraint()` Specifies whether the slot is required or optional.
`String`	`getSlotType()` The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
`String`	`getSlotTypeVersion()` The version of the slot type.
`Prompt`	`getValueElicitationPrompt()` The prompt that Amazon Lex uses to elicit the slot value from the user.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDefaultValueSpec(SlotDefaultValueSpec defaultValueSpec)` A list of default values for the slot.
`void`	`setDescription(String description)` A description of the slot.
`void`	`setName(String name)` The name of the slot.
`void`	`setObfuscationSetting(ObfuscationSetting obfuscationSetting)` Determines whether a slot is obfuscated in conversation logs and stored utterances.
`void`	`setObfuscationSetting(String obfuscationSetting)` Determines whether a slot is obfuscated in conversation logs and stored utterances.
`void`	`setPriority(Integer priority)` Directs Amazon Lex the order in which to elicit this slot value from the user.
`void`	`setResponseCard(String responseCard)` A set of possible responses for the slot type used by text-based clients.
`void`	`setSampleUtterances(Collection<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.
`void`	`setSlotConstraint(SlotConstraint slotConstraint)` Specifies whether the slot is required or optional.
`void`	`setSlotConstraint(String slotConstraint)` Specifies whether the slot is required or optional.
`void`	`setSlotType(String slotType)` The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
`void`	`setSlotTypeVersion(String slotTypeVersion)` The version of the slot type.
`void`	`setValueElicitationPrompt(Prompt valueElicitationPrompt)` The prompt that Amazon Lex uses to elicit the slot value from the user.
`String`	`toString()` Returns a string representation of this object.
`Slot`	`withDefaultValueSpec(SlotDefaultValueSpec defaultValueSpec)` A list of default values for the slot.
`Slot`	`withDescription(String description)` A description of the slot.
`Slot`	`withName(String name)` The name of the slot.
`Slot`	`withObfuscationSetting(ObfuscationSetting obfuscationSetting)` Determines whether a slot is obfuscated in conversation logs and stored utterances.
`Slot`	`withObfuscationSetting(String obfuscationSetting)` Determines whether a slot is obfuscated in conversation logs and stored utterances.
`Slot`	`withPriority(Integer priority)` Directs Amazon Lex the order in which to elicit this slot value from the user.
`Slot`	`withResponseCard(String responseCard)` A set of possible responses for the slot type used by text-based clients.
`Slot`	`withSampleUtterances(Collection<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.
`Slot`	`withSampleUtterances(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.
`Slot`	`withSlotConstraint(SlotConstraint slotConstraint)` Specifies whether the slot is required or optional.
`Slot`	`withSlotConstraint(String slotConstraint)` Specifies whether the slot is required or optional.
`Slot`	`withSlotType(String slotType)` The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
`Slot`	`withSlotTypeVersion(String slotTypeVersion)` The version of the slot type.
`Slot`	`withValueElicitationPrompt(Prompt valueElicitationPrompt)` The prompt that Amazon Lex uses to elicit the slot value from the user.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Slot
```
public Slot()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the slot.
    
    Parameters:
    
    name - The name of the slot.
  - getName
```
public String getName()
```
    The name of the slot.
    
    Returns:
    
    The name of the slot.
  - withName
```
public Slot withName(String name)
```
    The name of the slot.
    
    Parameters:
    
    name - The name of the slot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the slot.
    
    Parameters:
    
    description - A description of the slot.
  - getDescription
```
public String getDescription()
```
    A description of the slot.
    
    Returns:
    
    A description of the slot.
  - withDescription
```
public Slot withDescription(String description)
```
    A description of the slot.
    
    Parameters:
    
    description - A description of the slot.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSlotConstraint
```
public void setSlotConstraint(String slotConstraint)
```
    Specifies whether the slot is required or optional.
    
    Parameters:
    
    slotConstraint - Specifies whether the slot is required or optional.
    
    See Also:
    
    SlotConstraint
  - getSlotConstraint
```
public String getSlotConstraint()
```
    Specifies whether the slot is required or optional.
    
    Returns:
    
    Specifies whether the slot is required or optional.
    
    See Also:
    
    SlotConstraint
  - withSlotConstraint
```
public Slot withSlotConstraint(String slotConstraint)
```
    Specifies whether the slot is required or optional.
    
    Parameters:
    
    slotConstraint - Specifies whether the slot is required or optional.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SlotConstraint
  - setSlotConstraint
```
public void setSlotConstraint(SlotConstraint slotConstraint)
```
    Specifies whether the slot is required or optional.
    
    Parameters:
    
    slotConstraint - Specifies whether the slot is required or optional.
    
    See Also:
    
    SlotConstraint
  - withSlotConstraint
```
public Slot withSlotConstraint(SlotConstraint slotConstraint)
```
    Specifies whether the slot is required or optional.
    
    Parameters:
    
    slotConstraint - Specifies whether the slot is required or optional.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SlotConstraint
  - setSlotType
```
public void setSlotType(String slotType)
```
    The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
    
    Parameters:
    
    slotType - The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
  - getSlotType
```
public String getSlotType()
```
    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.
  - withSlotType
```
public Slot withSlotType(String slotType)
```
    The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
    
    Parameters:
    
    slotType - The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSlotTypeVersion
```
public void setSlotTypeVersion(String slotTypeVersion)
```
    The version of the slot type.
    
    Parameters:
    
    slotTypeVersion - The version of the slot type.
  - getSlotTypeVersion
```
public String getSlotTypeVersion()
```
    The version of the slot type.
    
    Returns:
    
    The version of the slot type.
  - withSlotTypeVersion
```
public Slot withSlotTypeVersion(String slotTypeVersion)
```
    The version of the slot type.
    
    Parameters:
    
    slotTypeVersion - The version of the slot type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValueElicitationPrompt
```
public void setValueElicitationPrompt(Prompt valueElicitationPrompt)
```
    The prompt that Amazon Lex uses to elicit the slot value from the user.
    
    Parameters:
    
    valueElicitationPrompt - The prompt that Amazon Lex uses to elicit the slot value from the user.
  - getValueElicitationPrompt
```
public Prompt getValueElicitationPrompt()
```
    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.
  - withValueElicitationPrompt
```
public Slot withValueElicitationPrompt(Prompt valueElicitationPrompt)
```
    The prompt that Amazon Lex uses to elicit the slot value from the user.
    
    Parameters:
    
    valueElicitationPrompt - The prompt that Amazon Lex uses to elicit the slot value from the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
public void setPriority(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.
    
    Parameters:
    
    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.
  - getPriority
```
public Integer getPriority()
```
    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.
  - withPriority
```
public Slot withPriority(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSampleUtterances
```
public List<String> getSampleUtterances()
```
    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.
    
    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.
  - setSampleUtterances
```
public void setSampleUtterances(Collection<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.
    
    Parameters:
    
    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.
  - withSampleUtterances
```
public Slot withSampleUtterances(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setSampleUtterances(java.util.Collection) or withSampleUtterances(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSampleUtterances
```
public Slot withSampleUtterances(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResponseCard
```
public void setResponseCard(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.
    
    Parameters:
    
    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.
  - getResponseCard
```
public String getResponseCard()
```
    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.
  - withResponseCard
```
public Slot withResponseCard(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setObfuscationSetting
```
public void setObfuscationSetting(String 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 .
    
    Parameters:
    
    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 .
    
    See Also:
    
    ObfuscationSetting
  - getObfuscationSetting
```
public String getObfuscationSetting()
```
    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 .
    
    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
  - withObfuscationSetting
```
public Slot withObfuscationSetting(String 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 .
    
    Parameters:
    
    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 .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObfuscationSetting
  - setObfuscationSetting
```
public void setObfuscationSetting(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 .
    
    Parameters:
    
    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 .
    
    See Also:
    
    ObfuscationSetting
  - withObfuscationSetting
```
public Slot withObfuscationSetting(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 .
    
    Parameters:
    
    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 .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObfuscationSetting
  - setDefaultValueSpec
```
public void setDefaultValueSpec(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.
    
    Parameters:
    
    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.
  - getDefaultValueSpec
```
public SlotDefaultValueSpec getDefaultValueSpec()
```
    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.
  - withDefaultValueSpec
```
public Slot withDefaultValueSpec(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Slot clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class Slot

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Slot

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

setSlotConstraint

getSlotConstraint

withSlotConstraint

setSlotConstraint

withSlotConstraint

setSlotType

getSlotType

withSlotType

setSlotTypeVersion

getSlotTypeVersion

withSlotTypeVersion

setValueElicitationPrompt

getValueElicitationPrompt

withValueElicitationPrompt

setPriority

getPriority

withPriority

getSampleUtterances

setSampleUtterances

withSampleUtterances

withSampleUtterances

setResponseCard

getResponseCard

withResponseCard

setObfuscationSetting

getObfuscationSetting

withObfuscationSetting

setObfuscationSetting

withObfuscationSetting

setDefaultValueSpec

getDefaultValueSpec

withDefaultValueSpec

toString

equals

hashCode

clone

marshall