com.amazonaws.services.qbusiness.model

Class BatchDeleteDocumentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.qbusiness.model.BatchDeleteDocumentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchDeleteDocumentRequest
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
BatchDeleteDocumentRequest()

Method Summary

Modifier and Type	Method and Description
BatchDeleteDocumentRequest	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 application.
String	getDataSourceSyncId() The identifier of the data source sync during which the documents were deleted.
List<DeleteDocument>	getDocuments() Documents deleted from the Amazon Q index.
String	getIndexId() The identifier of the Amazon Q index that contains the documents to delete.
int	hashCode()
void	setApplicationId(String applicationId) The identifier of the Amazon Q application.
void	setDataSourceSyncId(String dataSourceSyncId) The identifier of the data source sync during which the documents were deleted.
void	setDocuments(Collection<DeleteDocument> documents) Documents deleted from the Amazon Q index.
void	setIndexId(String indexId) The identifier of the Amazon Q index that contains the documents to delete.
String	toString() Returns a string representation of this object.
BatchDeleteDocumentRequest	withApplicationId(String applicationId) The identifier of the Amazon Q application.
BatchDeleteDocumentRequest	withDataSourceSyncId(String dataSourceSyncId) The identifier of the data source sync during which the documents were deleted.
BatchDeleteDocumentRequest	withDocuments(Collection<DeleteDocument> documents) Documents deleted from the Amazon Q index.
BatchDeleteDocumentRequest	withDocuments(DeleteDocument... documents) Documents deleted from the Amazon Q index.
BatchDeleteDocumentRequest	withIndexId(String indexId) The identifier of the Amazon Q index that contains the documents to delete.

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

BatchDeleteDocumentRequest

public BatchDeleteDocumentRequest()

Method Detail

setApplicationId

public void setApplicationId(String applicationId)

The identifier of the Amazon Q application.

Parameters:

applicationId - The identifier of the Amazon Q application.

getApplicationId

public String getApplicationId()

The identifier of the Amazon Q application.

Returns:

The identifier of the Amazon Q application.

withApplicationId

public BatchDeleteDocumentRequest withApplicationId(String applicationId)

The identifier of the Amazon Q application.

Parameters:

applicationId - The identifier of the Amazon Q application.

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

Parameters:

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

getDataSourceSyncId

public String getDataSourceSyncId()

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

Returns:

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

withDataSourceSyncId

public BatchDeleteDocumentRequest withDataSourceSyncId(String dataSourceSyncId)

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

Parameters:

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

Returns:

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

getDocuments

public List<DeleteDocument> getDocuments()

Documents deleted from the Amazon Q index.

Returns:

Documents deleted from the Amazon Q index.

setDocuments

public void setDocuments(Collection<DeleteDocument> documents)

Documents deleted from the Amazon Q index.

Parameters:

documents - Documents deleted from the Amazon Q index.

withDocuments

public BatchDeleteDocumentRequest withDocuments(DeleteDocument... documents)

Documents deleted from the Amazon Q 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 - Documents deleted from the Amazon Q index.

Returns:

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

withDocuments

public BatchDeleteDocumentRequest withDocuments(Collection<DeleteDocument> documents)

Documents deleted from the Amazon Q index.

Parameters:

documents - Documents deleted from the Amazon Q index.

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 index that contains the documents to delete.

Parameters:

indexId - The identifier of the Amazon Q index that contains the documents to delete.

getIndexId

public String getIndexId()

The identifier of the Amazon Q index that contains the documents to delete.

Returns:

The identifier of the Amazon Q index that contains the documents to delete.

withIndexId

public BatchDeleteDocumentRequest withIndexId(String indexId)

The identifier of the Amazon Q index that contains the documents to delete.

Parameters:

indexId - The identifier of the Amazon Q index that contains the documents to delete.

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