Class ImageResponseCard

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

A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.

When you use a response card, the response from the user is constrained to the text associated with a button on the card.

See Also:

  • Method Details

    • title

      public final String title()

      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

      Returns:
      The title to display on the response card. The format of the title is determined by the platform displaying the response card.

    • subtitle

      public final String subtitle()

      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

      Returns:
      The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

    • imageUrl

      public final String imageUrl()

      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

      Returns:
      The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

    • hasButtons

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

    • buttons

      public final List<Button> buttons()

      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

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

      Returns:
      A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

    • toBuilder

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

    • builder

      public static ImageResponseCard.Builder builder()

    • serializableBuilderClass

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