Package software.amazon.awssdk.services.kendra.model

Class BatchPutDocumentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kendra.model.KendraRequest

software.amazon.awssdk.services.kendra.model.BatchPutDocumentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchPutDocumentRequest.Builder,BatchPutDocumentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class BatchPutDocumentRequest
extends KendraRequest
implements ToCopyableBuilder<BatchPutDocumentRequest.Builder,BatchPutDocumentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchPutDocumentRequest.Builder

Method Summary

Modifier and Type	Method	Description
static BatchPutDocumentRequest.Builder	builder()
CustomDocumentEnrichmentConfiguration	customDocumentEnrichmentConfiguration()	Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API.
List<Document>	documents()	One or more documents to add to the index.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDocuments()	For responses, this returns true if the service returned a value for the Documents property.
int	hashCode()
String	indexId()	The identifier of the index to add the documents to.
String	roleArn()	The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchPutDocumentRequest.Builder>	serializableBuilderClass()
BatchPutDocumentRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

indexId

public final String indexId()

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

Returns:

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

roleArn

public final 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.

Returns:

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.

hasDocuments

public final boolean hasDocuments()

For responses, this returns true if the service returned a value for the Documents property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

documents

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDocuments() method.

Returns:

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.

customDocumentEnrichmentConfiguration

public final 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.

Returns:

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.

toBuilder

public BatchPutDocumentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchPutDocumentRequest.Builder,BatchPutDocumentRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static BatchPutDocumentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends BatchPutDocumentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo