Interface BatchPutDocumentRequest.Builder

All Superinterfaces:

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

Enclosing class:

BatchPutDocumentRequest

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

Method Summary

Modifier and Type	Method	Description
BatchPutDocumentRequest.Builder	applicationId(String applicationId)	The identifier of the Amazon Q Business application.
BatchPutDocumentRequest.Builder	dataSourceSyncId(String dataSourceSyncId)	The identifier of the data source sync during which the documents were added.
BatchPutDocumentRequest.Builder	documents(Collection<Document> documents)	One or more documents to add to the index.
BatchPutDocumentRequest.Builder	documents(Consumer<Document.Builder>... documents)	One or more documents to add to the index.
BatchPutDocumentRequest.Builder	documents(Document... documents)	One or more documents to add to the index.
BatchPutDocumentRequest.Builder	indexId(String indexId)	The identifier of the Amazon Q Business index to add the documents to.
BatchPutDocumentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
BatchPutDocumentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
BatchPutDocumentRequest.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

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

BatchPutDocumentRequest.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

BatchPutDocumentRequest.Builder indexId(String indexId)

The identifier of the Amazon Q Business index to add the documents to.

Parameters:

indexId - The identifier of the Amazon Q Business index to add the documents to.

Returns:

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

documents

BatchPutDocumentRequest.Builder documents(Collection<Document> documents)

One or more documents to add to the index.

Parameters:

documents - One or more documents to add to the index.

Returns:

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

documents

BatchPutDocumentRequest.Builder documents(Document... documents)

One or more documents to add to the index.

Parameters:

documents - One or more documents to add to the index.

Returns:

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

documents

BatchPutDocumentRequest.Builder documents(Consumer<Document.Builder>... documents)

One or more documents to add to the index.

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

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

Parameters:

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

Returns:

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

See Also:

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

roleArn

BatchPutDocumentRequest.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

Returns:

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

dataSourceSyncId

BatchPutDocumentRequest.Builder dataSourceSyncId(String dataSourceSyncId)

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

Parameters:

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

Returns:

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

overrideConfiguration

BatchPutDocumentRequest.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

BatchPutDocumentRequest.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.