Class QQueryCardInput

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

The input shape for defining a query card in an Amazon Q App.

See Also:

  • Method Details

    • title

      public final String title()

      The title or label of the query card.

      Returns:
      The title or label of the query card.

    • id

      public final String id()

      The unique identifier of the query card.

      Returns:
      The unique identifier of the query card.

    • type

      public final CardType type()

      The type of the card.

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

      Returns:
      The type of the card.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the card.

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

      Returns:
      The type of the card.
      See Also:

    • prompt

      public final String prompt()

      The prompt or instructions displayed for the query card.

      Returns:
      The prompt or instructions displayed for the query card.

    • outputSource

      public final CardOutputSource outputSource()

      The source or type of output to generate for the query card.

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

      Returns:
      The source or type of output to generate for the query card.
      See Also:

    • outputSourceAsString

      public final String outputSourceAsString()

      The source or type of output to generate for the query card.

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

      Returns:
      The source or type of output to generate for the query card.
      See Also:

    • attributeFilter

      public final AttributeFilter attributeFilter()

      Turns on filtering of responses based on document attributes or metadata fields.

      Returns:
      Turns on filtering of responses based on document attributes or metadata fields.

    • toBuilder

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

    • builder

      public static QQueryCardInput.Builder builder()

    • serializableBuilderClass

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