software.amazon.awssdk.services.lexruntimev2.model

Class Slot

java.lang.Object

software.amazon.awssdk.services.lexruntimev2.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>

A value that Amazon Lex V2 uses to fulfill an intent.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Slot.Builder

Method Summary

Modifier and Type	Method and Description
static Slot.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSubSlots() For responses, this returns true if the service returned a value for the SubSlots property.
boolean	hasValues() For responses, this returns true if the service returned a value for the Values property.
List<SdkField<?>>	sdkFields()
static Class<? extends Slot.Builder>	serializableBuilderClass()
Shape	shape() When the shape value is List, it indicates that the values field contains a list of slot values.
String	shapeAsString() When the shape value is List, it indicates that the values field contains a list of slot values.
Map<String,Slot>	subSlots() The constituent sub slots of a composite slot.
Slot.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Value	value() The current value of the slot.
List<Slot>	values() A list of one or more values that the user provided 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

value

public final Value value()

The current value of the slot.

Returns:

The current value of the slot.

shape

public final Shape shape()

When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value.

If the service returns an enum value that is not available in the current SDK version, shape will return Shape.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shapeAsString().

Returns:

When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value.

See Also:

Shape

shapeAsString

public final String shapeAsString()

When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value.

If the service returns an enum value that is not available in the current SDK version, shape will return Shape.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shapeAsString().

Returns:

When the shape value is List, it indicates that the values field contains a list of slot values. When the value is Scalar, it indicates that the value field contains a single value.

See Also:

Shape

hasValues

public final boolean hasValues()

For responses, this returns true if the service returned a value for the Values 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.

values

public final List<Slot> values()

A list of one or more values that the user provided for the slot. For example, if a for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

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 hasValues() method.

Returns:

A list of one or more values that the user provided for the slot. For example, if a for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."

hasSubSlots

public final boolean hasSubSlots()

For responses, this returns true if the service returned a value for the SubSlots 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.

subSlots

public final Map<String,Slot> subSlots()

The constituent sub slots of a composite slot.

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 hasSubSlots() method.

Returns:

The constituent sub slots of a composite slot.

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