com.amazonaws.services.qbusiness.model

Class BatchPutDocumentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.qbusiness.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() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApplicationId() The identifier of the Amazon Q Business application.
String	getDataSourceSyncId() The identifier of the data source sync during which the documents were added.
List<Document>	getDocuments() One or more documents to add to the index.
String	getIndexId() The identifier of the Amazon Q Business index to add the documents to.
String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.
int	hashCode()
void	setApplicationId(String applicationId) The identifier of the Amazon Q Business application.
void	setDataSourceSyncId(String dataSourceSyncId) The identifier of the data source sync during which the documents were added.
void	setDocuments(Collection<Document> documents) One or more documents to add to the index.
void	setIndexId(String indexId) The identifier of the Amazon Q Business index to add the documents to.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.
String	toString() Returns a string representation of this object.
BatchPutDocumentRequest	withApplicationId(String applicationId) The identifier of the Amazon Q Business application.
BatchPutDocumentRequest	withDataSourceSyncId(String dataSourceSyncId) The identifier of the data source sync during which the documents were added.
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 Amazon Q Business index to add the documents to.
BatchPutDocumentRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, 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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchPutDocumentRequest

public BatchPutDocumentRequest()

Method Detail

setApplicationId

public void setApplicationId(String applicationId)

The identifier of the Amazon Q Business application.

Parameters:

applicationId - The identifier of the Amazon Q Business application.

getApplicationId

public String getApplicationId()

The identifier of the Amazon Q Business application.

Returns:

The identifier of the Amazon Q Business application.

withApplicationId

public BatchPutDocumentRequest withApplicationId(String applicationId)

The identifier of the Amazon Q Business application.

Parameters:

applicationId - The identifier of the Amazon Q Business application.

Returns:

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

setIndexId

public void setIndexId(String indexId)

The identifier of the Amazon Q Business index to add the documents to.

Parameters:

indexId - The identifier of the Amazon Q Business index to add the documents to.

getIndexId

public String getIndexId()

The identifier of the Amazon Q Business index to add the documents to.

Returns:

The identifier of the Amazon Q Business index to add the documents to.

withIndexId

public BatchPutDocumentRequest withIndexId(String indexId)

The identifier of the Amazon Q Business index to add the documents to.

Parameters:

indexId - The identifier of the Amazon Q Business index to add the documents to.

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.

Returns:

One or more documents to add to the index.

setDocuments

public void setDocuments(Collection<Document> documents)

One or more documents to add to the index.

Parameters:

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

withDocuments

public BatchPutDocumentRequest withDocuments(Document... documents)

One or more documents to add to the index.

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.

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.

Parameters:

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

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 an IAM role with permission to access your S3 bucket.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

getRoleArn

public String getRoleArn()

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

Returns:

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

withRoleArn

public BatchPutDocumentRequest withRoleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

Returns:

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

setDataSourceSyncId

public void setDataSourceSyncId(String dataSourceSyncId)

The identifier of the data source sync during which the documents were added.

Parameters:

dataSourceSyncId - The identifier of the data source sync during which the documents were added.

getDataSourceSyncId

public String getDataSourceSyncId()

The identifier of the data source sync during which the documents were added.

Returns:

The identifier of the data source sync during which the documents were added.

withDataSourceSyncId

public BatchPutDocumentRequest withDataSourceSyncId(String dataSourceSyncId)

The identifier of the data source sync during which the documents were added.

Parameters:

dataSourceSyncId - The identifier of the data source sync during which the documents were added.

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()