FulfillmentUpdateResponseSpecification (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lexmodelsv2.model.FulfillmentUpdateResponseSpecification

All Implemented Interfaces:

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FulfillmentUpdateResponseSpecification()

Constructors
Constructor and Description
`FulfillmentUpdateResponseSpecification()`

Method Summary

All Methods Instance Methods Concrete Methods
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()` One to 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)` One to 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)` One to 5 message groups that contain update messages.
`FulfillmentUpdateResponseSpecification`	`withMessageGroups(MessageGroup... messageGroups)` One to 5 message groups that contain update messages.

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

- Constructor Detail
  - FulfillmentUpdateResponseSpecification
```
public FulfillmentUpdateResponseSpecification()
```
- Method Detail
  - setFrequencyInSeconds
```
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.
    
    Parameters:
    
    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.
  - getFrequencyInSeconds
```
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.
    
    Returns:
    
    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.
  - withFrequencyInSeconds
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMessageGroups
```
public List<MessageGroup> getMessageGroups()
```
    One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
    
    Returns:
    
    One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
  - setMessageGroups
```
public void setMessageGroups(Collection<MessageGroup> messageGroups)
```
    One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
    
    Parameters:
    
    messageGroups - One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
  - withMessageGroups
```
public FulfillmentUpdateResponseSpecification withMessageGroups(MessageGroup... messageGroups)
```
    One to 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.
    
    Parameters:
    
    messageGroups - One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMessageGroups
```
public FulfillmentUpdateResponseSpecification withMessageGroups(Collection<MessageGroup> messageGroups)
```
    One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
    
    Parameters:
    
    messageGroups - One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAllowInterrupt
```
public void setAllowInterrupt(Boolean allowInterrupt)
```
    Determines whether the user can interrupt an update message while it is playing.
    
    Parameters:
    
    allowInterrupt - Determines whether the user can interrupt an update message while it is playing.
  - getAllowInterrupt
```
public Boolean getAllowInterrupt()
```
    Determines whether the user can interrupt an update message while it is playing.
    
    Returns:
    
    Determines whether the user can interrupt an update message while it is playing.
  - withAllowInterrupt
```
public FulfillmentUpdateResponseSpecification withAllowInterrupt(Boolean allowInterrupt)
```
    Determines whether the user can interrupt an update message while it is playing.
    
    Parameters:
    
    allowInterrupt - Determines whether the user can interrupt an update message while it is playing.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAllowInterrupt
```
public Boolean isAllowInterrupt()
```
    Determines whether the user can interrupt an update message while it is playing.
    
    Returns:
    
    Determines whether the user can interrupt an update message while it is playing.
  - toString
```
public 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
    
    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 FulfillmentUpdateResponseSpecification 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 FulfillmentUpdateResponseSpecification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FulfillmentUpdateResponseSpecification

Method Detail

setFrequencyInSeconds

getFrequencyInSeconds

withFrequencyInSeconds

getMessageGroups

setMessageGroups

withMessageGroups

withMessageGroups

setAllowInterrupt

getAllowInterrupt

withAllowInterrupt

isAllowInterrupt

toString

equals

hashCode

clone

marshall