Package software.amazon.awssdk.services.qbusiness.model

Interface BatchDeleteDocumentResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<BatchDeleteDocumentResponse.Builder,BatchDeleteDocumentResponse>, QBusinessResponse.Builder, SdkBuilder<BatchDeleteDocumentResponse.Builder,BatchDeleteDocumentResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

BatchDeleteDocumentResponse

public static interface BatchDeleteDocumentResponse.Builder
extends QBusinessResponse.Builder, SdkPojo, CopyableBuilder<BatchDeleteDocumentResponse.Builder,BatchDeleteDocumentResponse>

Method Summary

Modifier and Type	Method	Description
BatchDeleteDocumentResponse.Builder	failedDocuments(Collection<FailedDocument> failedDocuments)	A list of documents that couldn't be removed from the Amazon Q index.
BatchDeleteDocumentResponse.Builder	failedDocuments(Consumer<FailedDocument.Builder>... failedDocuments)	A list of documents that couldn't be removed from the Amazon Q index.
BatchDeleteDocumentResponse.Builder	failedDocuments(FailedDocument... failedDocuments)	A list of documents that couldn't be removed from the Amazon Q index.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.QBusinessResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

failedDocuments

BatchDeleteDocumentResponse.Builder failedDocuments(Collection<FailedDocument> failedDocuments)

A list of documents that couldn't be removed from the Amazon Q index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

Parameters:

failedDocuments - A list of documents that couldn't be removed from the Amazon Q index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

Returns:

Returns a reference to this object so that method calls can be chained together.

failedDocuments

BatchDeleteDocumentResponse.Builder failedDocuments(FailedDocument... failedDocuments)

A list of documents that couldn't be removed from the Amazon Q index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

Parameters:

failedDocuments - A list of documents that couldn't be removed from the Amazon Q index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

Returns:

Returns a reference to this object so that method calls can be chained together.

failedDocuments

BatchDeleteDocumentResponse.Builder failedDocuments(Consumer<FailedDocument.Builder>... failedDocuments)

A list of documents that couldn't be removed from the Amazon Q index. Each entry contains an error message that indicates why the document couldn't be removed from the index.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #failedDocuments(List).

Parameters:

failedDocuments - a consumer that will call methods on FailedDocument.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#failedDocuments(java.util.Collection)