@Generated(value="software.amazon.awssdk:codegen") public class Prompt extends Object implements StructuredPojo, 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.
Modifier and Type | Class and Description |
---|---|
static interface |
Prompt.Builder |
Modifier and Type | Method and Description |
---|---|
static Prompt.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
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.
|
static Class<? extends Prompt.Builder> |
serializableBuilderClass() |
Prompt.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public 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.
public Integer maxAttempts()
The number of times to prompt the user for information.
public 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.
PostText
API response. It
substitutes session attributes and slot values for placeholders in the response card. For more
information, see ex-resp-card.public Prompt.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Prompt.Builder,Prompt>
public static Prompt.Builder builder()
public static Class<? extends Prompt.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.