Class CardInput

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

The properties defining an input card in an Amazon Q App.

See Also:

  • Method Details

    • textInput

      public final TextInputCardInput textInput()

      A container for the properties of the text input card.

      Returns:
      A container for the properties of the text input card.

    • qQuery

      public final QQueryCardInput qQuery()

      A container for the properties of the query input card.

      Returns:
      A container for the properties of the query input card.

    • qPlugin

      public final QPluginCardInput qPlugin()

      A container for the properties of the plugin input card.

      Returns:
      A container for the properties of the plugin input card.

    • fileUpload

      public final FileUploadCardInput fileUpload()

      A container for the properties of the file upload input card.

      Returns:
      A container for the properties of the file upload input card.

    • formInput

      public final FormInputCardInput formInput()

      A container for the properties of the form input card.

      Returns:
      A container for the properties of the form input card.

    • toBuilder

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

    • builder

      public static CardInput.Builder builder()

    • serializableBuilderClass

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

    • fromTextInput

      public static CardInput fromTextInput(TextInputCardInput textInput)
      Create an instance of this class with textInput() initialized to the given value.

      A container for the properties of the text input card.

      Parameters:
      textInput - A container for the properties of the text input card.

    • fromTextInput

      public static CardInput fromTextInput(Consumer<TextInputCardInput.Builder> textInput)
      Create an instance of this class with textInput() initialized to the given value.

      A container for the properties of the text input card.

      Parameters:
      textInput - A container for the properties of the text input card.

    • fromQQuery

      public static CardInput fromQQuery(QQueryCardInput qQuery)
      Create an instance of this class with qQuery() initialized to the given value.

      A container for the properties of the query input card.

      Parameters:
      qQuery - A container for the properties of the query input card.

    • fromQQuery

      public static CardInput fromQQuery(Consumer<QQueryCardInput.Builder> qQuery)
      Create an instance of this class with qQuery() initialized to the given value.

      A container for the properties of the query input card.

      Parameters:
      qQuery - A container for the properties of the query input card.

    • fromQPlugin

      public static CardInput fromQPlugin(QPluginCardInput qPlugin)
      Create an instance of this class with qPlugin() initialized to the given value.

      A container for the properties of the plugin input card.

      Parameters:
      qPlugin - A container for the properties of the plugin input card.

    • fromQPlugin

      public static CardInput fromQPlugin(Consumer<QPluginCardInput.Builder> qPlugin)
      Create an instance of this class with qPlugin() initialized to the given value.

      A container for the properties of the plugin input card.

      Parameters:
      qPlugin - A container for the properties of the plugin input card.

    • fromFileUpload

      public static CardInput fromFileUpload(FileUploadCardInput fileUpload)
      Create an instance of this class with fileUpload() initialized to the given value.

      A container for the properties of the file upload input card.

      Parameters:
      fileUpload - A container for the properties of the file upload input card.

    • fromFileUpload

      public static CardInput fromFileUpload(Consumer<FileUploadCardInput.Builder> fileUpload)
      Create an instance of this class with fileUpload() initialized to the given value.

      A container for the properties of the file upload input card.

      Parameters:
      fileUpload - A container for the properties of the file upload input card.

    • fromFormInput

      public static CardInput fromFormInput(FormInputCardInput formInput)
      Create an instance of this class with formInput() initialized to the given value.

      A container for the properties of the form input card.

      Parameters:
      formInput - A container for the properties of the form input card.

    • fromFormInput

      public static CardInput fromFormInput(Consumer<FormInputCardInput.Builder> formInput)
      Create an instance of this class with formInput() initialized to the given value.

      A container for the properties of the form input card.

      Parameters:
      formInput - A container for the properties of the form input card.

    • type

      public CardInput.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be CardInput.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be CardInput.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • 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.