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

Interface FailedDocument.Builder

All Superinterfaces:

Buildable, CopyableBuilder<FailedDocument.Builder,FailedDocument>, SdkBuilder<FailedDocument.Builder,FailedDocument>, SdkPojo

Enclosing class:

FailedDocument

public static interface FailedDocument.Builder
extends SdkPojo, CopyableBuilder<FailedDocument.Builder,FailedDocument>

Method Summary

Modifier and Type	Method	Description
FailedDocument.Builder	dataSourceId(String dataSourceId)	The identifier of the Amazon Q Business data source connector that contains the failed document.
default FailedDocument.Builder	error(Consumer<ErrorDetail.Builder> error)	An explanation for why the document couldn't be removed from the index.
FailedDocument.Builder	error(ErrorDetail error)	An explanation for why the document couldn't be removed from the index.
FailedDocument.Builder	id(String id)	The identifier of the document that couldn't be removed from the Amazon Q Business index.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Detail

id

FailedDocument.Builder id(String id)

The identifier of the document that couldn't be removed from the Amazon Q Business index.

Parameters:

id - The identifier of the document that couldn't be removed from the Amazon Q Business index.

Returns:

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

error

FailedDocument.Builder error(ErrorDetail error)

An explanation for why the document couldn't be removed from the index.

Parameters:

error - An explanation for 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.

error

default FailedDocument.Builder error(Consumer<ErrorDetail.Builder> error)

An explanation for why the document couldn't be removed from the index.

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

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

Parameters:

error - a consumer that will call methods on ErrorDetail.Builder

Returns:

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

See Also:

error(ErrorDetail)

dataSourceId

FailedDocument.Builder dataSourceId(String dataSourceId)

The identifier of the Amazon Q Business data source connector that contains the failed document.

Parameters:

dataSourceId - The identifier of the Amazon Q Business data source connector that contains the failed document.

Returns:

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