Package software.amazon.awssdk.services.lexmodelbuilding.model

Class Slot

java.lang.Object

software.amazon.awssdk.services.lexmodelbuilding.model.Slot

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Slot.Builder,Slot>

@Generated("software.amazon.awssdk:codegen")
public class Slot
extends Object
implements StructuredPojo, ToCopyableBuilder<Slot.Builder,Slot>

Identifies the version of a specific slot.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Slot.Builder

Method Summary

Modifier and Type	Method	Description
static Slot.Builder	builder()
String	description()	A description of the slot.
boolean	equals(Object obj)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	name()	The name of the slot.
Integer	priority()	Directs 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.
static Class<? extends Slot.Builder>	serializableBuilderClass()
String	slotConstraint()	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()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

Method Detail

name

public String name()

The name of the slot.

Returns:

The name of the slot.

description

public String description()

A description of the slot.

Returns:

A description of the slot.

slotConstraint

public String slotConstraint()

Specifies whether the slot is required or optional.

Returns:

Specifies whether the slot is required or optional.

See Also:

SlotConstraint

slotType

public 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 String slotTypeVersion()

The version of the slot type.

Returns:

The version of the slot type.

valueElicitationPrompt

public 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 Integer priority()

Directs 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 Lex first elicits a value for the slot with priority 1.

If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.

Returns:

Directs 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 Lex first elicits a value for the slot with priority 1.

If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.

sampleUtterances

public 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.

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 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.

toBuilder

public Slot.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<Slot.Builder,Slot>

Returns:

a builder for type T

builder

public static Slot.Builder builder()

serializableBuilderClass

public static Class<? extends Slot.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString 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.