@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class FulfillmentUpdateResponseSpecification extends Object implements Serializable, Cloneable, StructuredPojo
Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.
Constructor and Description |
---|
FulfillmentUpdateResponseSpecification() |
Modifier and Type | Method and Description |
---|---|
FulfillmentUpdateResponseSpecification |
clone() |
boolean |
equals(Object obj) |
Boolean |
getAllowInterrupt()
Determines whether the user can interrupt an update message while it is playing.
|
Integer |
getFrequencyInSeconds()
The frequency that a message is sent to the user.
|
List<MessageGroup> |
getMessageGroups()
1 - 5 message groups that contain update messages.
|
int |
hashCode() |
Boolean |
isAllowInterrupt()
Determines whether the user can interrupt an update message while it is playing.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAllowInterrupt(Boolean allowInterrupt)
Determines whether the user can interrupt an update message while it is playing.
|
void |
setFrequencyInSeconds(Integer frequencyInSeconds)
The frequency that a message is sent to the user.
|
void |
setMessageGroups(Collection<MessageGroup> messageGroups)
1 - 5 message groups that contain update messages.
|
String |
toString()
Returns a string representation of this object.
|
FulfillmentUpdateResponseSpecification |
withAllowInterrupt(Boolean allowInterrupt)
Determines whether the user can interrupt an update message while it is playing.
|
FulfillmentUpdateResponseSpecification |
withFrequencyInSeconds(Integer frequencyInSeconds)
The frequency that a message is sent to the user.
|
FulfillmentUpdateResponseSpecification |
withMessageGroups(Collection<MessageGroup> messageGroups)
1 - 5 message groups that contain update messages.
|
FulfillmentUpdateResponseSpecification |
withMessageGroups(MessageGroup... messageGroups)
1 - 5 message groups that contain update messages.
|
public FulfillmentUpdateResponseSpecification()
public void setFrequencyInSeconds(Integer frequencyInSeconds)
The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
frequencyInSeconds
- The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from
the message groups and plays it to the user. If the fulfillment Lambda returns before the first period
ends, an update message is not played to the user.public Integer getFrequencyInSeconds()
The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
public FulfillmentUpdateResponseSpecification withFrequencyInSeconds(Integer frequencyInSeconds)
The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
frequencyInSeconds
- The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from
the message groups and plays it to the user. If the fulfillment Lambda returns before the first period
ends, an update message is not played to the user.public List<MessageGroup> getMessageGroups()
1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
public void setMessageGroups(Collection<MessageGroup> messageGroups)
1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
messageGroups
- 1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the
user.public FulfillmentUpdateResponseSpecification withMessageGroups(MessageGroup... messageGroups)
1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
NOTE: This method appends the values to the existing list (if any). Use
setMessageGroups(java.util.Collection)
or withMessageGroups(java.util.Collection)
if you want
to override the existing values.
messageGroups
- 1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the
user.public FulfillmentUpdateResponseSpecification withMessageGroups(Collection<MessageGroup> messageGroups)
1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
messageGroups
- 1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the
user.public void setAllowInterrupt(Boolean allowInterrupt)
Determines whether the user can interrupt an update message while it is playing.
allowInterrupt
- Determines whether the user can interrupt an update message while it is playing.public Boolean getAllowInterrupt()
Determines whether the user can interrupt an update message while it is playing.
public FulfillmentUpdateResponseSpecification withAllowInterrupt(Boolean allowInterrupt)
Determines whether the user can interrupt an update message while it is playing.
allowInterrupt
- Determines whether the user can interrupt an update message while it is playing.public Boolean isAllowInterrupt()
Determines whether the user can interrupt an update message while it is playing.
public String toString()
toString
in class Object
Object.toString()
public FulfillmentUpdateResponseSpecification clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.