@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Prompt extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
Prompt() |
Modifier and Type | Method and Description |
---|---|
Prompt |
clone() |
boolean |
equals(Object obj) |
Integer |
getMaxAttempts()
The number of times to prompt the user for information.
|
List<Message> |
getMessages()
An array of objects, each of which provides a message string and its type.
|
String |
getResponseCard()
A response card.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setMaxAttempts(Integer maxAttempts)
The number of times to prompt the user for information.
|
void |
setMessages(Collection<Message> messages)
An array of objects, each of which provides a message string and its type.
|
void |
setResponseCard(String responseCard)
A response card.
|
String |
toString()
Returns a string representation of this object.
|
Prompt |
withMaxAttempts(Integer maxAttempts)
The number of times to prompt the user for information.
|
Prompt |
withMessages(Collection<Message> messages)
An array of objects, each of which provides a message string and its type.
|
Prompt |
withMessages(Message... messages)
An array of objects, each of which provides a message string and its type.
|
Prompt |
withResponseCard(String responseCard)
A response card.
|
public List<Message> getMessages()
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).
public void setMessages(Collection<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).
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).public Prompt withMessages(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).
NOTE: This method appends the values to the existing list (if any). Use
setMessages(java.util.Collection)
or withMessages(java.util.Collection)
if you want to override
the existing values.
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).public Prompt withMessages(Collection<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).
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).public void setMaxAttempts(Integer maxAttempts)
The number of times to prompt the user for information.
maxAttempts
- The number of times to prompt the user for information.public Integer getMaxAttempts()
The number of times to prompt the user for information.
public Prompt withMaxAttempts(Integer maxAttempts)
The number of times to prompt the user for information.
maxAttempts
- The number of times to prompt the user for information.public void setResponseCard(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.
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.public String getResponseCard()
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 withResponseCard(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.
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.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.