Class UtteranceBotResponse

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

An object that contains a response to the utterance from the bot.

See Also:

  • Method Details

    • content

      public final String content()

      The text of the response to the utterance from the bot.

      Returns:
      The text of the response to the utterance from the bot.

    • contentType

      public final UtteranceContentType contentType()

      The type of the response. The following values are possible:

      • PlainText – A plain text string.

      • CustomPayload – A response string that you can customize to include data or metadata for your application.

      • SSML – A string that includes Speech Synthesis Markup Language to customize the audio response.

      • ImageResponseCard – An image with buttons that the customer can select. See ImageResponseCard for more information.

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

      Returns:
      The type of the response. The following values are possible:

      • PlainText – A plain text string.

      • CustomPayload – A response string that you can customize to include data or metadata for your application.

      • SSML – A string that includes Speech Synthesis Markup Language to customize the audio response.

      • ImageResponseCard – An image with buttons that the customer can select. See ImageResponseCard for more information.

      See Also:

    • contentTypeAsString

      public final String contentTypeAsString()

      The type of the response. The following values are possible:

      • PlainText – A plain text string.

      • CustomPayload – A response string that you can customize to include data or metadata for your application.

      • SSML – A string that includes Speech Synthesis Markup Language to customize the audio response.

      • ImageResponseCard – An image with buttons that the customer can select. See ImageResponseCard for more information.

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

      Returns:
      The type of the response. The following values are possible:

      • PlainText – A plain text string.

      • CustomPayload – A response string that you can customize to include data or metadata for your application.

      • SSML – A string that includes Speech Synthesis Markup Language to customize the audio response.

      • ImageResponseCard – An image with buttons that the customer can select. See ImageResponseCard for more information.

      See Also:

    • imageResponseCard

      public final ImageResponseCard imageResponseCard()
      Returns the value of the ImageResponseCard property for this object.
      Returns:
      The value of the ImageResponseCard property for this object.

    • toBuilder

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

    • builder

      public static UtteranceBotResponse.Builder builder()

    • serializableBuilderClass

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