software.amazon.awssdk.services.kendra.model

Interface BatchPutDocumentRequest.Builder

All Superinterfaces:

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

Enclosing class:

BatchPutDocumentRequest

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

Method Summary

Modifier and Type	Method and Description
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 index to add the documents to.
BatchPutDocumentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
BatchPutDocumentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
BatchPutDocumentRequest.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation.

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

indexId

BatchPutDocumentRequest.Builder indexId(String indexId)

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

Parameters:

indexId - The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

Returns:

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

roleArn

BatchPutDocumentRequest.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra.

Parameters:

roleArn - The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra.

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.

Documents have the following file size limits.

• 5 MB total size for inline documents

• 50 MB total size for files from an S3 bucket

• 5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

Parameters:

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

Documents have the following file size limits.

• 5 MB total size for inline documents

• 50 MB total size for files from an S3 bucket

• 5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

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.

Documents have the following file size limits.

• 5 MB total size for inline documents

• 50 MB total size for files from an S3 bucket

• 5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

Parameters:

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

Documents have the following file size limits.

• 5 MB total size for inline documents

• 50 MB total size for files from an S3 bucket

• 5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

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.

Documents have the following file size limits.

• 5 MB total size for inline documents

• 50 MB total size for files from an S3 bucket

• 5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #documents(List).

Parameters:

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

Returns:

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

See Also:

#documents(List)

overrideConfiguration

BatchPutDocumentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder