com.amazonaws.services.kendra.model

Class BatchPutDocumentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.BatchPutDocumentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchPutDocumentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
BatchPutDocumentRequest()

Method Summary

Modifier and Type	Method and Description
BatchPutDocumentRequest	clone()
boolean	equals(Object obj)
CustomDocumentEnrichmentConfiguration	getCustomDocumentEnrichmentConfiguration() Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument operation.
List<Document>	getDocuments() One or more documents to add to the index.
String	getIndexId() The identifier of the index to add the documents to.
String	getRoleArn() The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation.
int	hashCode()
void	setCustomDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration) Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument operation.
void	setDocuments(Collection<Document> documents) One or more documents to add to the index.
void	setIndexId(String indexId) The identifier of the index to add the documents to.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation.
String	toString() Returns a string representation of this object.
BatchPutDocumentRequest	withCustomDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration) Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument operation.
BatchPutDocumentRequest	withDocuments(Collection<Document> documents) One or more documents to add to the index.
BatchPutDocumentRequest	withDocuments(Document... documents) One or more documents to add to the index.
BatchPutDocumentRequest	withIndexId(String indexId) The identifier of the index to add the documents to.
BatchPutDocumentRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchPutDocumentRequest

public BatchPutDocumentRequest()

Method Detail

setIndexId

public void setIndexId(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.

getIndexId

public String getIndexId()

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.

withIndexId

public BatchPutDocumentRequest withIndexId(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.

setRoleArn

public void setRoleArn(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.

getRoleArn

public String getRoleArn()

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.

withRoleArn

public BatchPutDocumentRequest withRoleArn(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.

getDocuments

public List<Document> getDocuments()

One or more documents to add to the index.

Documents can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

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:

One or more documents to add to the index.

Documents can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

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.

setDocuments

public void setDocuments(Collection<Document> documents)

One or more documents to add to the index.

Documents can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

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 can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

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.

withDocuments

public BatchPutDocumentRequest withDocuments(Document... documents)

One or more documents to add to the index.

Documents can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

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.

NOTE: This method appends the values to the existing list (if any). Use setDocuments(java.util.Collection) or withDocuments(java.util.Collection) if you want to override the existing values.

Parameters:

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

Documents can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

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.

withDocuments

public BatchPutDocumentRequest withDocuments(Collection<Document> documents)

One or more documents to add to the index.

Documents can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

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 can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

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.

setCustomDocumentEnrichmentConfiguration

public void setCustomDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration)

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

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

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.

getCustomDocumentEnrichmentConfiguration

public CustomDocumentEnrichmentConfiguration getCustomDocumentEnrichmentConfiguration()

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

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

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.

withCustomDocumentEnrichmentConfiguration

public BatchPutDocumentRequest withCustomDocumentEnrichmentConfiguration(CustomDocumentEnrichmentConfiguration customDocumentEnrichmentConfiguration)

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

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

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.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public BatchPutDocumentRequest clone()

Overrides:

clone in class AmazonWebServiceRequest