Interface QuerySummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<QuerySummary.Builder,QuerySummary>, SdkBuilder<QuerySummary.Builder,QuerySummary>, SdkPojo
Enclosing class:
QuerySummary
@Mutable @NotThreadSafe public static interface QuerySummary.Builder extends SdkPojo, CopyableBuilder<QuerySummary.Builder,QuerySummary>

  • Method Details

    • queryIdentifier

      QuerySummary.Builder queryIdentifier(Integer queryIdentifier)

      Sequential identifier of the query within the inquiry.

      Parameters:
      queryIdentifier - Sequential identifier of the query within the inquiry.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • query

      QuerySummary.Builder query(String query)

      The actual query text.

      Parameters:
      query - The actual query text.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • response

      QuerySummary.Builder response(String response)

      Generated response to the query.

      Parameters:
      response - Generated response to the query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reviewType

      QuerySummary.Builder reviewType(String reviewType)

      Type of review for the response.

      Parameters:
      reviewType - Type of review for the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • reviewType

      QuerySummary.Builder reviewType(ReviewType reviewType)

      Type of review for the response.

      Parameters:
      reviewType - Type of review for the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • citations

      QuerySummary.Builder citations(Collection<Citation> citations)

      Supporting citations for the response.

      Parameters:
      citations - Supporting citations for the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • citations

      QuerySummary.Builder citations(Citation... citations)

      Supporting citations for the response.

      Parameters:
      citations - Supporting citations for the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • citations

      QuerySummary.Builder citations(Consumer<Citation.Builder>... citations)

      Supporting citations for the response.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to citations(List<Citation>).

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

    • status

      QuerySummary.Builder status(String status)

      Current processing status of the query.

      Parameters:
      status - Current processing status of the query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      QuerySummary.Builder status(QueryStatus status)

      Current processing status of the query.

      Parameters:
      status - Current processing status of the query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusMessage

      QuerySummary.Builder statusMessage(String statusMessage)

      Descriptive status message.

      Parameters:
      statusMessage - Descriptive status message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusMessage

      QuerySummary.Builder statusMessage(QueryStatusMessage statusMessage)

      Descriptive status message.

      Parameters:
      statusMessage - Descriptive status message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      QuerySummary.Builder createdAt(Instant createdAt)

      Timestamp when the query was created.

      Parameters:
      createdAt - Timestamp when the query was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedResponseVersions

      QuerySummary.Builder updatedResponseVersions(Collection<ResponseVersion> updatedResponseVersions)

      Ordered list of response version history entries, oldest first.

      Parameters:
      updatedResponseVersions - Ordered list of response version history entries, oldest first.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedResponseVersions

      QuerySummary.Builder updatedResponseVersions(ResponseVersion... updatedResponseVersions)

      Ordered list of response version history entries, oldest first.

      Parameters:
      updatedResponseVersions - Ordered list of response version history entries, oldest first.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedResponseVersions

      QuerySummary.Builder updatedResponseVersions(Consumer<ResponseVersion.Builder>... updatedResponseVersions)

      Ordered list of response version history entries, oldest first.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to updatedResponseVersions(List<ResponseVersion>).

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