Class Slot
- java.lang.Object
-
- software.amazon.awssdk.services.lexruntimev2.model.Slot
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Slot.Builder,Slot>
@Generated("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 Description static interfaceSlot.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Slot.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasSubSlots()For responses, this returns true if the service returned a value for the SubSlots property.booleanhasValues()For responses, this returns true if the service returned a value for the Values property.List<SdkField<?>>sdkFields()static Class<? extends Slot.Builder>serializableBuilderClass()Shapeshape()When theshapevalue isList, it indicates that thevaluesfield contains a list of slot values.StringshapeAsString()When theshapevalue isList, it indicates that thevaluesfield contains a list of slot values.Map<String,Slot>subSlots()The constituent sub slots of a composite slot.Slot.BuildertoBuilder()StringtoString()Returns a string representation of this object.Valuevalue()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
shapevalue isList, it indicates that thevaluesfield contains a list of slot values. When the value isScalar, it indicates that thevaluefield contains a single value.If the service returns an enum value that is not available in the current SDK version,
shapewill returnShape.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromshapeAsString().- Returns:
- When the
shapevalue isList, it indicates that thevaluesfield contains a list of slot values. When the value isScalar, it indicates that thevaluefield contains a single value. - See Also:
Shape
-
shapeAsString
public final String shapeAsString()
When the
shapevalue isList, it indicates that thevaluesfield contains a list of slot values. When the value isScalar, it indicates that thevaluefield contains a single value.If the service returns an enum value that is not available in the current SDK version,
shapewill returnShape.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromshapeAsString().- Returns:
- When the
shapevalue isList, it indicates that thevaluesfield contains a list of slot values. When the value isScalar, it indicates that thevaluefield 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 theisEmpty()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 theisEmpty()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:
toBuilderin interfaceToCopyableBuilder<Slot.Builder,Slot>
-
builder
public static Slot.Builder builder()
-
serializableBuilderClass
public static Class<? extends Slot.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-