Class QQueryCard

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

A card in a Amazon Q App that generates a response based on the Amazon Q Business service.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier of the query card.

      Returns:
      The unique identifier of the query card.

    • title

      public final String title()

      The title or label of the query card.

      Returns:
      The title or label of the query card.

    • hasDependencies

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

    • dependencies

      public final List<String> dependencies()

      Any dependencies or requirements for the query card.

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

      Returns:
      Any dependencies or requirements for 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 generated by 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 generated by the query card.
      See Also:

    • outputSourceAsString

      public final String outputSourceAsString()

      The source or type of output generated by 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 generated by the query card.
      See Also:

    • attributeFilter

      public final AttributeFilter attributeFilter()

      The Amazon Q Business filters applied in this query card when resolving data sources

      Returns:
      The Amazon Q Business filters applied in this query card when resolving data sources

    • hasMemoryReferences

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

    • memoryReferences

      public final List<String> memoryReferences()

      Any dependencies for the query card, where the dependencies are references to the collected responses.

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

      Returns:
      Any dependencies for the query card, where the dependencies are references to the collected responses.

    • toBuilder

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

    • builder

      public static QQueryCard.Builder builder()

    • serializableBuilderClass

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