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(value="software.amazon.awssdk:codegen")
public final class BatchPutDocumentRequest
extends KendraRequest
implements ToCopyableBuilder<BatchPutDocumentRequest.Builder,BatchPutDocumentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchPutDocumentRequest.Builder

Method Summary

Modifier and Type	Method and Description
static BatchPutDocumentRequest.Builder	builder()
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() Returns true if the Documents property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	indexId() The identifier of the index to add the documents to.
String	roleArn() The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation.
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 String indexId()

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

Returns:

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

roleArn

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

Returns:

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.

hasDocuments

public boolean hasDocuments()

Returns true if the Documents property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

documents

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

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

You can use hasDocuments() to see if a value was sent in this field.

Returns:

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.

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 int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo