software.amazon.awssdk.services.lexruntimev2.model

Class RuntimeHintDetails

java.lang.Object

software.amazon.awssdk.services.lexruntimev2.model.RuntimeHintDetails

All Implemented Interfaces:

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

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

Provides an array of phrases that should be given preference when resolving values for a slot.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RuntimeHintDetails.Builder

Method Summary

Modifier and Type	Method and Description
static RuntimeHintDetails.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRuntimeHintValues() For responses, this returns true if the service returned a value for the RuntimeHintValues property.
boolean	hasSubSlotHints() For responses, this returns true if the service returned a value for the SubSlotHints property.
List<RuntimeHintValue>	runtimeHintValues() One or more strings that Amazon Lex V2 should look for in the input to the bot.
List<SdkField<?>>	sdkFields()
static Class<? extends RuntimeHintDetails.Builder>	serializableBuilderClass()
Map<String,RuntimeHintDetails>	subSlotHints() A map of constituent sub slot names inside a composite slot in the intent and the phrases that should be added for each sub slot.
RuntimeHintDetails.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

hasRuntimeHintValues

public final boolean hasRuntimeHintValues()

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

runtimeHintValues

public final List<RuntimeHintValue> runtimeHintValues()

One or more strings that Amazon Lex V2 should look for in the input to the bot. Each phrase is given preference when deciding on slot values.

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

Returns:

One or more strings that Amazon Lex V2 should look for in the input to the bot. Each phrase is given preference when deciding on slot values.

hasSubSlotHints

public final boolean hasSubSlotHints()

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

subSlotHints

public final Map<String,RuntimeHintDetails> subSlotHints()

A map of constituent sub slot names inside a composite slot in the intent and the phrases that should be added for each sub slot. Inside each composite slot hints, this structure provides a mechanism to add granular sub slot phrases. Only sub slot hints are supported for composite slots. The intent name, composite slot name and the constituent sub slot names must exist.

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

Returns:

A map of constituent sub slot names inside a composite slot in the intent and the phrases that should be added for each sub slot. Inside each composite slot hints, this structure provides a mechanism to add granular sub slot phrases. Only sub slot hints are supported for composite slots. The intent name, composite slot name and the constituent sub slot names must exist.

toBuilder

public RuntimeHintDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RuntimeHintDetails.Builder,RuntimeHintDetails>

builder

public static RuntimeHintDetails.Builder builder()

serializableBuilderClass

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