Interface RetrieveResponse.Builder

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

  • Method Details

    • results

      RetrieveResponse.Builder results(Collection<RetrieveResult> results)

      The results of the content retrieval operation.

      Parameters:
      results - The results of the content retrieval operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • results

      RetrieveResponse.Builder results(RetrieveResult... results)

      The results of the content retrieval operation.

      Parameters:
      results - The results of the content retrieval operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • results

      RetrieveResponse.Builder results(Consumer<RetrieveResult.Builder>... results)

      The results of the content retrieval operation.

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

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

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

    • errors

      RetrieveResponse.Builder errors(Collection<RetrieveError> errors)

      The per-association errors returned when one or more knowledge base associations fail during a Retrieve operation that spans multiple assistant associations. The overall operation still succeeds and returns the results from the associations that were queried successfully. This list contains one entry for each association that failed, up to a maximum of five.

      Parameters:
      errors - The per-association errors returned when one or more knowledge base associations fail during a Retrieve operation that spans multiple assistant associations. The overall operation still succeeds and returns the results from the associations that were queried successfully. This list contains one entry for each association that failed, up to a maximum of five.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errors

      RetrieveResponse.Builder errors(RetrieveError... errors)

      The per-association errors returned when one or more knowledge base associations fail during a Retrieve operation that spans multiple assistant associations. The overall operation still succeeds and returns the results from the associations that were queried successfully. This list contains one entry for each association that failed, up to a maximum of five.

      Parameters:
      errors - The per-association errors returned when one or more knowledge base associations fail during a Retrieve operation that spans multiple assistant associations. The overall operation still succeeds and returns the results from the associations that were queried successfully. This list contains one entry for each association that failed, up to a maximum of five.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errors

      RetrieveResponse.Builder errors(Consumer<RetrieveError.Builder>... errors)

      The per-association errors returned when one or more knowledge base associations fail during a Retrieve operation that spans multiple assistant associations. The overall operation still succeeds and returns the results from the associations that were queried successfully. This list contains one entry for each association that failed, up to a maximum of five.

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

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

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