Package software.amazon.awssdk.services.lexmodelbuilding.model

Class Prompt

java.lang.Object

software.amazon.awssdk.services.lexmodelbuilding.model.Prompt

All Implemented Interfaces:

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

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

Obtains information from the user. To define a prompt, provide one or more messages and specify the number of attempts to get information from the user. If you provide more than one message, Amazon Lex chooses one of the messages to use to prompt the user. For more information, see how-it-works.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Prompt.Builder

Method Summary

Modifier and Type	Method	Description
static Prompt.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMessages()	For responses, this returns true if the service returned a value for the Messages property.
Integer	maxAttempts()	The number of times to prompt the user for information.
List<Message>	messages()	An array of objects, each of which provides a message string and its type.
String	responseCard()	A response card.
List<SdkField<?>>	sdkFields()
static Class<? extends Prompt.Builder>	serializableBuilderClass()
Prompt.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

hasMessages

public final boolean hasMessages()

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

messages

public final List<Message> messages()

An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

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

Returns:

An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

maxAttempts

public final Integer maxAttempts()

The number of times to prompt the user for information.

Returns:

The number of times to prompt the user for information.

responseCard

public final String responseCard()

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

Returns:

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

toBuilder

public Prompt.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Prompt.Builder,Prompt>

builder

public static Prompt.Builder builder()

serializableBuilderClass

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