software.amazon.awssdk.services.lexmodelsv2.model

Class SlotSummary

java.lang.Object

software.amazon.awssdk.services.lexmodelsv2.model.SlotSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SlotSummary.Builder,SlotSummary>

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

Summary information about a slot, a value that the bot elicits from the user.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SlotSummary.Builder

Method Summary

Modifier and Type	Method and Description
static SlotSummary.Builder	builder()
String	description() The description of the slot.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedDateTime() The timestamp of the last date and time that the slot was updated.
List<SdkField<?>>	sdkFields()
static Class<? extends SlotSummary.Builder>	serializableBuilderClass()
SlotConstraint	slotConstraint() Whether the slot is required or optional.
String	slotConstraintAsString() Whether the slot is required or optional.
String	slotId() The unique identifier of the slot.
String	slotName() The name given to the slot.
String	slotTypeId() The unique identifier for the slot type that defines the values for the slot.
SlotSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.
PromptSpecification	valueElicitationPromptSpecification() Prompts that are sent to the user to elicit a value for the slot.

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

slotId

public final String slotId()

The unique identifier of the slot.

Returns:

The unique identifier of the slot.

slotName

public final String slotName()

The name given to the slot.

Returns:

The name given to the slot.

description

public final String description()

The description of the slot.

Returns:

The description of the slot.

slotConstraint

public final SlotConstraint slotConstraint()

Whether the slot is required or optional. An intent is complete when all required slots are filled.

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:

Whether the slot is required or optional. An intent is complete when all required slots are filled.

See Also:

SlotConstraint

slotConstraintAsString

public final String slotConstraintAsString()

Whether the slot is required or optional. An intent is complete when all required slots are filled.

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:

Whether the slot is required or optional. An intent is complete when all required slots are filled.

See Also:

SlotConstraint

slotTypeId

public final String slotTypeId()

The unique identifier for the slot type that defines the values for the slot.

Returns:

The unique identifier for the slot type that defines the values for the slot.

valueElicitationPromptSpecification

public final PromptSpecification valueElicitationPromptSpecification()

Prompts that are sent to the user to elicit a value for the slot.

Returns:

Prompts that are sent to the user to elicit a value for the slot.

lastUpdatedDateTime

public final Instant lastUpdatedDateTime()

The timestamp of the last date and time that the slot was updated.

Returns:

The timestamp of the last date and time that the slot was updated.

toBuilder

public SlotSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SlotSummary.Builder,SlotSummary>

builder

public static SlotSummary.Builder builder()

serializableBuilderClass

public static Class<? extends SlotSummary.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