Class FulfillmentStartResponseSpecification

java.lang.Object
software.amazon.awssdk.services.lexmodelsv2.model.FulfillmentStartResponseSpecification
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FulfillmentStartResponseSpecification.Builder,FulfillmentStartResponseSpecification>
@Generated("software.amazon.awssdk:codegen") public final class FulfillmentStartResponseSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FulfillmentStartResponseSpecification.Builder,FulfillmentStartResponseSpecification>

Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.

See Also:

  • Method Details

    • delayInSeconds

      public final Integer delayInSeconds()

      The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.

      Returns:
      The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.

    • 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 the isEmpty() 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 start 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 start messages. Amazon Lex chooses one of the messages to play to the user.

    • allowInterrupt

      public final Boolean allowInterrupt()

      Determines whether the user can interrupt the start message while it is playing.

      Returns:
      Determines whether the user can interrupt the start message while it is playing.

    • toBuilder

      public FulfillmentStartResponseSpecification.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FulfillmentStartResponseSpecification.Builder,FulfillmentStartResponseSpecification>
      Returns:
      a builder for type T

    • builder

      public static FulfillmentStartResponseSpecification.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FulfillmentStartResponseSpecification.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.