Interface BatchDeleteDocumentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<BatchDeleteDocumentRequest.Builder,BatchDeleteDocumentRequest>, QBusinessRequest.Builder, SdkBuilder<BatchDeleteDocumentRequest.Builder,BatchDeleteDocumentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

BatchDeleteDocumentRequest

@Mutable
@NotThreadSafe
public static interface BatchDeleteDocumentRequest.Builder
extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<BatchDeleteDocumentRequest.Builder,BatchDeleteDocumentRequest>

Method Summary

Modifier and Type	Method	Description
BatchDeleteDocumentRequest.Builder	applicationId(String applicationId)	The identifier of the Amazon Q Business application.
BatchDeleteDocumentRequest.Builder	dataSourceSyncId(String dataSourceSyncId)	The identifier of the data source sync during which the documents were deleted.
BatchDeleteDocumentRequest.Builder	documents(Collection<DeleteDocument> documents)	Documents deleted from the Amazon Q Business index.
BatchDeleteDocumentRequest.Builder	documents(Consumer<DeleteDocument.Builder>... documents)	Documents deleted from the Amazon Q Business index.
BatchDeleteDocumentRequest.Builder	documents(DeleteDocument... documents)	Documents deleted from the Amazon Q Business index.
BatchDeleteDocumentRequest.Builder	indexId(String indexId)	The identifier of the Amazon Q Business index that contains the documents to delete.
BatchDeleteDocumentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
BatchDeleteDocumentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

applicationId

BatchDeleteDocumentRequest.Builder applicationId(String applicationId)

The identifier of the Amazon Q Business application.

Parameters:

applicationId - The identifier of the Amazon Q Business application.

Returns:

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

indexId

BatchDeleteDocumentRequest.Builder indexId(String indexId)

The identifier of the Amazon Q Business index that contains the documents to delete.

Parameters:

indexId - The identifier of the Amazon Q Business index that contains the documents to delete.

Returns:

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

documents

BatchDeleteDocumentRequest.Builder documents(Collection<DeleteDocument> documents)

Documents deleted from the Amazon Q Business index.

Parameters:

documents - Documents deleted from the Amazon Q Business index.

Returns:

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

documents

BatchDeleteDocumentRequest.Builder documents(DeleteDocument... documents)

Documents deleted from the Amazon Q Business index.

Parameters:

documents - Documents deleted from the Amazon Q Business index.

Returns:

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

documents

BatchDeleteDocumentRequest.Builder documents(Consumer<DeleteDocument.Builder>... documents)

Documents deleted from the Amazon Q Business index.

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

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

Parameters:

documents - a consumer that will call methods on DeleteDocument.Builder

Returns:

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

See Also:

• documents(java.util.Collection<DeleteDocument>)

dataSourceSyncId

BatchDeleteDocumentRequest.Builder dataSourceSyncId(String dataSourceSyncId)

The identifier of the data source sync during which the documents were deleted.

Parameters:

dataSourceSyncId - The identifier of the data source sync during which the documents were deleted.

Returns:

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

overrideConfiguration

BatchDeleteDocumentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

BatchDeleteDocumentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.