software.amazon.awssdk.services.lexmodelsv2.model

Class SlotValueElicitationSetting

java.lang.Object

software.amazon.awssdk.services.lexmodelsv2.model.SlotValueElicitationSetting

All Implemented Interfaces:

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

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

Specifies the elicitation setting details eliciting a slot.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SlotValueElicitationSetting.Builder

Method Summary

Modifier and Type	Method and Description
static SlotValueElicitationSetting.Builder	builder()
SlotDefaultValueSpecification	defaultValueSpecification() A list of default values for a slot.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSampleUtterances() For responses, this returns true if the service returned a value for the SampleUtterances property.
PromptSpecification	promptSpecification() The prompt that Amazon Lex uses to elicit the slot value from the user.
List<SampleUtterance>	sampleUtterances() If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy.
List<SdkField<?>>	sdkFields()
static Class<? extends SlotValueElicitationSetting.Builder>	serializableBuilderClass()
SlotCaptureSetting	slotCaptureSetting() Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
SlotConstraint	slotConstraint() Specifies whether the slot is required or optional.
String	slotConstraintAsString() Specifies whether the slot is required or optional.
SlotValueElicitationSetting.Builder	toBuilder()
String	toString() Returns a string representation of this object.
WaitAndContinueSpecification	waitAndContinueSpecification() Returns the value of the WaitAndContinueSpecification property for 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

defaultValueSpecification

public final SlotDefaultValueSpecification defaultValueSpecification()

A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

Returns:

A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

slotConstraint

public final SlotConstraint slotConstraint()

Specifies whether the slot is required or optional.

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:

Specifies whether the slot is required or optional.

See Also:

SlotConstraint

slotConstraintAsString

public final String slotConstraintAsString()

Specifies whether the slot is required or optional.

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:

Specifies whether the slot is required or optional.

See Also:

SlotConstraint

promptSpecification

public final PromptSpecification promptSpecification()

The prompt that Amazon Lex uses to elicit the slot value from the user.

Returns:

The prompt that Amazon Lex uses to elicit the slot value from the user.

hasSampleUtterances

public final boolean hasSampleUtterances()

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

sampleUtterances

public final List<SampleUtterance> sampleUtterances()

If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

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

Returns:

If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

waitAndContinueSpecification

public final WaitAndContinueSpecification waitAndContinueSpecification()

Returns the value of the WaitAndContinueSpecification property for this object.

Returns:

The value of the WaitAndContinueSpecification property for this object.

slotCaptureSetting

public final SlotCaptureSetting slotCaptureSetting()

Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.

Returns:

Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.

toBuilder

public SlotValueElicitationSetting.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SlotValueElicitationSetting.Builder,SlotValueElicitationSetting>

builder

public static SlotValueElicitationSetting.Builder builder()

serializableBuilderClass

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