Prompt (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lexmodelbuilding.model.Prompt

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Prompt()

Constructors
Constructor and Description
`Prompt()`

Method Summary

All Methods Instance Methods Concrete Methods
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; useful for testing and debugging.
`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Prompt
```
public Prompt()
```
- Method Detail
  - getMessages
```
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).
    
    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).
  - setMessages
```
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).
    
    Parameters:
    
    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).
  - withMessages
```
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.
    
    Parameters:
    
    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).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMessages
```
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).
    
    Parameters:
    
    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).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxAttempts
```
public void setMaxAttempts(Integer maxAttempts)
```
    The number of times to prompt the user for information.
    
    Parameters:
    
    maxAttempts - The number of times to prompt the user for information.
  - getMaxAttempts
```
public Integer getMaxAttempts()
```
    The number of times to prompt the user for information.
    
    Returns:
    
    The number of times to prompt the user for information.
  - withMaxAttempts
```
public Prompt withMaxAttempts(Integer maxAttempts)
```
    The number of times to prompt the user for information.
    
    Parameters:
    
    maxAttempts - The number of times to prompt the user for information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResponseCard
```
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.
    
    Parameters:
    
    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.
  - getResponseCard
```
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.
    
    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.
  - withResponseCard
```
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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Prompt clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Prompt

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Prompt

Method Detail

getMessages

setMessages

withMessages

withMessages

setMaxAttempts

getMaxAttempts

withMaxAttempts

setResponseCard

getResponseCard

withResponseCard

toString

equals

hashCode

clone

marshall