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

Interface BatchPutDocumentResponse.Builder

All Superinterfaces:

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

Enclosing class:

BatchPutDocumentResponse

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

Method Summary

Modifier and Type	Method	Description
BatchPutDocumentResponse.Builder	failedDocuments(Collection<FailedDocument> failedDocuments)	A list of documents that were not added to the Amazon Q index because the document failed a validation check.
BatchPutDocumentResponse.Builder	failedDocuments(Consumer<FailedDocument.Builder>... failedDocuments)	A list of documents that were not added to the Amazon Q index because the document failed a validation check.
BatchPutDocumentResponse.Builder	failedDocuments(FailedDocument... failedDocuments)	A list of documents that were not added to the Amazon Q index because the document failed a validation check.

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

BatchPutDocumentResponse.Builder failedDocuments(Collection<FailedDocument> failedDocuments)

A list of documents that were not added to the Amazon Q index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.

Parameters:

failedDocuments - A list of documents that were not added to the Amazon Q index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.

Returns:

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

failedDocuments

BatchPutDocumentResponse.Builder failedDocuments(FailedDocument... failedDocuments)

A list of documents that were not added to the Amazon Q index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.

Parameters:

failedDocuments - A list of documents that were not added to the Amazon Q index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.

Returns:

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

failedDocuments

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

A list of documents that were not added to the Amazon Q index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to 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)