Package software.amazon.awssdk.services.lexruntimev2.model

Class Value

java.lang.Object

software.amazon.awssdk.services.lexruntimev2.model.Value

All Implemented Interfaces:

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

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

Information about the value provided for a slot and Amazon Lex V2's interpretation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Value.Builder

Method Summary

Modifier and Type	Method	Description
static Value.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResolvedValues()	For responses, this returns true if the service returned a value for the ResolvedValues property.
String	interpretedValue()	The value that Amazon Lex V2 determines for the slot, given the user input.
String	originalValue()	The part of the user's response to the slot elicitation that Amazon Lex V2 determines is relevant to the slot value.
List<String>	resolvedValues()	A list of values that Amazon Lex V2 determines are possible resolutions for the user input.
List<SdkField<?>>	sdkFields()
static Class<? extends Value.Builder>	serializableBuilderClass()
Value.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

originalValue

public final String originalValue()

The part of the user's response to the slot elicitation that Amazon Lex V2 determines is relevant to the slot value.

Returns:

The part of the user's response to the slot elicitation that Amazon Lex V2 determines is relevant to the slot value.

interpretedValue

public final String interpretedValue()

The value that Amazon Lex V2 determines for the slot, given the user input. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex V2 choose the first value in the resolvedValues list.

Returns:

The value that Amazon Lex V2 determines for the slot, given the user input. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex V2 choose the first value in the resolvedValues list.

hasResolvedValues

public final boolean hasResolvedValues()

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

resolvedValues

public final List<String> resolvedValues()

A list of values that Amazon Lex V2 determines are possible resolutions for the user input. The first value matches the interpretedValue.

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

Returns:

A list of values that Amazon Lex V2 determines are possible resolutions for the user input. The first value matches the interpretedValue.

toBuilder

public Value.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Value.Builder,Value>

builder

public static Value.Builder builder()

serializableBuilderClass

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