Interface BatchDeleteDocumentRequest.Builder

All Superinterfaces:

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

Enclosing class:

BatchDeleteDocumentRequest

public static interface BatchDeleteDocumentRequest.Builder
extends KendraRequest.Builder, SdkPojo, CopyableBuilder<BatchDeleteDocumentRequest.Builder,BatchDeleteDocumentRequest>

Method Summary

Modifier and Type	Method	Description
default BatchDeleteDocumentRequest.Builder	dataSourceSyncJobMetricTarget(Consumer<DataSourceSyncJobMetricTarget.Builder> dataSourceSyncJobMetricTarget)	Sets the value of the DataSourceSyncJobMetricTarget property for this object.
BatchDeleteDocumentRequest.Builder	dataSourceSyncJobMetricTarget(DataSourceSyncJobMetricTarget dataSourceSyncJobMetricTarget)	Sets the value of the DataSourceSyncJobMetricTarget property for this object.
BatchDeleteDocumentRequest.Builder	documentIdList(String... documentIdList)	One or more identifiers for documents to delete from the index.
BatchDeleteDocumentRequest.Builder	documentIdList(Collection<String> documentIdList)	One or more identifiers for documents to delete from the index.
BatchDeleteDocumentRequest.Builder	indexId(String indexId)	The identifier of the 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.kendra.model.KendraRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Details

indexId

BatchDeleteDocumentRequest.Builder indexId(String indexId)

The identifier of the index that contains the documents to delete.

Parameters:

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

Returns:

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

documentIdList

BatchDeleteDocumentRequest.Builder documentIdList(Collection<String> documentIdList)

One or more identifiers for documents to delete from the index.

Parameters:

documentIdList - One or more identifiers for documents to delete from the index.

Returns:

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

documentIdList

BatchDeleteDocumentRequest.Builder documentIdList(String... documentIdList)

One or more identifiers for documents to delete from the index.

Parameters:

documentIdList - One or more identifiers for documents to delete from the index.

Returns:

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

dataSourceSyncJobMetricTarget

BatchDeleteDocumentRequest.Builder dataSourceSyncJobMetricTarget(DataSourceSyncJobMetricTarget dataSourceSyncJobMetricTarget)

Sets the value of the DataSourceSyncJobMetricTarget property for this object.

Parameters:

dataSourceSyncJobMetricTarget - The new value for the DataSourceSyncJobMetricTarget property for this object.

Returns:

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

dataSourceSyncJobMetricTarget

default BatchDeleteDocumentRequest.Builder dataSourceSyncJobMetricTarget(Consumer<DataSourceSyncJobMetricTarget.Builder> dataSourceSyncJobMetricTarget)

Sets the value of the DataSourceSyncJobMetricTarget property for this object. This is a convenience method that creates an instance of the DataSourceSyncJobMetricTarget.Builder avoiding the need to create one manually via DataSourceSyncJobMetricTarget.builder().

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

Parameters:

dataSourceSyncJobMetricTarget - a consumer that will call methods on DataSourceSyncJobMetricTarget.Builder

Returns:

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

See Also:

• dataSourceSyncJobMetricTarget(DataSourceSyncJobMetricTarget)

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.