Interface QQueryCard.Builder

  • Method Details

    • id

      The unique identifier of the query card.

      Parameters:
      id - The unique identifier of the query card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • title

      QQueryCard.Builder title(String title)

      The title or label of the query card.

      Parameters:
      title - The title or label of the query card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dependencies

      QQueryCard.Builder dependencies(Collection<String> dependencies)

      Any dependencies or requirements for the query card.

      Parameters:
      dependencies - Any dependencies or requirements for the query card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dependencies

      QQueryCard.Builder dependencies(String... dependencies)

      Any dependencies or requirements for the query card.

      Parameters:
      dependencies - Any dependencies or requirements for the query card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • type

      The type of the card.

      Parameters:
      type - The type of the card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • type

      The type of the card.

      Parameters:
      type - The type of the card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • prompt

      QQueryCard.Builder prompt(String prompt)

      The prompt or instructions displayed for the query card.

      Parameters:
      prompt - The prompt or instructions displayed for the query card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • outputSource

      QQueryCard.Builder outputSource(String outputSource)

      The source or type of output generated by the query card.

      Parameters:
      outputSource - The source or type of output generated by the query card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • outputSource

      QQueryCard.Builder outputSource(CardOutputSource outputSource)

      The source or type of output generated by the query card.

      Parameters:
      outputSource - The source or type of output generated by the query card.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • attributeFilter

      QQueryCard.Builder attributeFilter(AttributeFilter attributeFilter)

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

      Parameters:
      attributeFilter - The Amazon Q Business filters applied in this query card when resolving data sources
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • attributeFilter

      default QQueryCard.Builder attributeFilter(Consumer<AttributeFilter.Builder> attributeFilter)

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

      This is a convenience method that creates an instance of the AttributeFilter.Builder avoiding the need to create one manually via AttributeFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attributeFilter(AttributeFilter).

      Parameters:
      attributeFilter - a consumer that will call methods on AttributeFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • memoryReferences

      QQueryCard.Builder memoryReferences(Collection<String> memoryReferences)

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

      Parameters:
      memoryReferences - Any dependencies for the query card, where the dependencies are references to the collected responses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • memoryReferences

      QQueryCard.Builder memoryReferences(String... memoryReferences)

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

      Parameters:
      memoryReferences - Any dependencies for the query card, where the dependencies are references to the collected responses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.