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	Description
default BatchPutDocumentRequest.Builder	customDocumentEnrichmentConfiguration(Consumer<CustomDocumentEnrichmentConfiguration.Builder> customDocumentEnrichmentConfiguration)	Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API.
BatchPutDocumentRequest.Builder	customDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration)	Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API.
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(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.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

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

Parameters:

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

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 an IAM role with permission to access your S3 bucket. For more information, see IAM access roles for Amazon Kendra.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket. For more information, see IAM access 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.

• 50 MB total size for any file

• 5 MB extracted text for any file

For more information, see Quotas.

Parameters:

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

Documents have the following file size limits.

• 50 MB total size for any file

• 5 MB extracted text for any file

For more information, 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.

• 50 MB total size for any file

• 5 MB extracted text for any file

For more information, see Quotas.

Parameters:

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

Documents have the following file size limits.

• 50 MB total size for any file

• 5 MB extracted text for any file

For more information, 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.

• 50 MB total size for any file

• 5 MB extracted text for any file

For more information, see Quotas.

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>)

customDocumentEnrichmentConfiguration

BatchPutDocumentRequest.Builder customDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration)

Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

Parameters:

customDocumentEnrichmentConfiguration - Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

Returns:

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

customDocumentEnrichmentConfiguration

default BatchPutDocumentRequest.Builder customDocumentEnrichmentConfiguration(Consumer<CustomDocumentEnrichmentConfiguration.Builder> customDocumentEnrichmentConfiguration)

Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

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

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

Parameters:

customDocumentEnrichmentConfiguration - a consumer that will call methods on CustomDocumentEnrichmentConfiguration.Builder

Returns:

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

See Also:

• customDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration)

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.