Class FulfillmentUpdateResponseSpecification
- java.lang.Object
-
- software.amazon.awssdk.services.lexmodelsv2.model.FulfillmentUpdateResponseSpecification
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<FulfillmentUpdateResponseSpecification.Builder,FulfillmentUpdateResponseSpecification>
@Generated("software.amazon.awssdk:codegen") public final class FulfillmentUpdateResponseSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FulfillmentUpdateResponseSpecification.Builder,FulfillmentUpdateResponseSpecification>
Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFulfillmentUpdateResponseSpecification.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanallowInterrupt()Determines whether the user can interrupt an update message while it is playing.static FulfillmentUpdateResponseSpecification.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)IntegerfrequencyInSeconds()The frequency that a message is sent to the user.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasMessageGroups()For responses, this returns true if the service returned a value for the MessageGroups property.List<MessageGroup>messageGroups()1 - 5 message groups that contain update messages.List<SdkField<?>>sdkFields()static Class<? extends FulfillmentUpdateResponseSpecification.Builder>serializableBuilderClass()FulfillmentUpdateResponseSpecification.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
frequencyInSeconds
public final 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.
- 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.
-
hasMessageGroups
public final boolean hasMessageGroups()
For responses, this returns true if the service returned a value for the MessageGroups property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
messageGroups
public final List<MessageGroup> messageGroups()
1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMessageGroups()method.- Returns:
- 1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
-
allowInterrupt
public final Boolean allowInterrupt()
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.
-
toBuilder
public FulfillmentUpdateResponseSpecification.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FulfillmentUpdateResponseSpecification.Builder,FulfillmentUpdateResponseSpecification>
-
builder
public static FulfillmentUpdateResponseSpecification.Builder builder()
-
serializableBuilderClass
public static Class<? extends FulfillmentUpdateResponseSpecification.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final 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.
-
-