Class PromptSpecification

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

Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.

See Also:

  • Method Details

    • 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()

      A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

      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:
      A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

    • maxRetries

      public final Integer maxRetries()

      The maximum number of times the bot tries to elicit a response from the user using this prompt.

      Returns:
      The maximum number of times the bot tries to elicit a response from the user using this prompt.

    • allowInterrupt

      public final Boolean allowInterrupt()

      Indicates whether the user can interrupt a speech prompt from the bot.

      Returns:
      Indicates whether the user can interrupt a speech prompt from the bot.

    • messageSelectionStrategy

      public final MessageSelectionStrategy messageSelectionStrategy()

      Indicates how a message is selected from a message group among retries.

      If the service returns an enum value that is not available in the current SDK version, messageSelectionStrategy will return MessageSelectionStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageSelectionStrategyAsString().

      Returns:
      Indicates how a message is selected from a message group among retries.
      See Also:

    • messageSelectionStrategyAsString

      public final String messageSelectionStrategyAsString()

      Indicates how a message is selected from a message group among retries.

      If the service returns an enum value that is not available in the current SDK version, messageSelectionStrategy will return MessageSelectionStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageSelectionStrategyAsString().

      Returns:
      Indicates how a message is selected from a message group among retries.
      See Also:

    • promptAttemptsSpecification

      public final Map<PromptAttempt,PromptAttemptSpecification> promptAttemptsSpecification()

      Specifies the advanced settings on each attempt of the prompt.

      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 hasPromptAttemptsSpecification() method.

      Returns:
      Specifies the advanced settings on each attempt of the prompt.

    • hasPromptAttemptsSpecification

      public final boolean hasPromptAttemptsSpecification()
      For responses, this returns true if the service returned a value for the PromptAttemptsSpecification 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.

    • promptAttemptsSpecificationAsStrings

      public final Map<String,PromptAttemptSpecification> promptAttemptsSpecificationAsStrings()

      Specifies the advanced settings on each attempt of the prompt.

      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 hasPromptAttemptsSpecification() method.

      Returns:
      Specifies the advanced settings on each attempt of the prompt.

    • toBuilder

      public PromptSpecification.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<PromptSpecification.Builder,PromptSpecification>
      Returns:
      a builder for type T

    • builder

      public static PromptSpecification.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PromptSpecification.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.