com.amazonaws.services.kendra.model

Class BatchDeleteDocumentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.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)
DataSourceSyncJobMetricTarget	getDataSourceSyncJobMetricTarget()
List<String>	getDocumentIdList() One or more identifiers for documents to delete from the index.
String	getIndexId() The identifier of the index that contains the documents to delete.
int	hashCode()
void	setDataSourceSyncJobMetricTarget(DataSourceSyncJobMetricTarget dataSourceSyncJobMetricTarget)
void	setDocumentIdList(Collection<String> documentIdList) One or more identifiers for documents to delete from the index.
void	setIndexId(String indexId) The identifier of the index that contains the documents to delete.
String	toString() Returns a string representation of this object.
BatchDeleteDocumentRequest	withDataSourceSyncJobMetricTarget(DataSourceSyncJobMetricTarget dataSourceSyncJobMetricTarget)
BatchDeleteDocumentRequest	withDocumentIdList(Collection<String> documentIdList) One or more identifiers for documents to delete from the index.
BatchDeleteDocumentRequest	withDocumentIdList(String... documentIdList) One or more identifiers for documents to delete from the index.
BatchDeleteDocumentRequest	withIndexId(String indexId) The identifier of the 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

setIndexId

public void setIndexId(String indexId)

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

Parameters:

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

getIndexId

public String getIndexId()

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

Returns:

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

withIndexId

public BatchDeleteDocumentRequest withIndexId(String indexId)

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

Parameters:

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

Returns:

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

getDocumentIdList

public List<String> getDocumentIdList()

One or more identifiers for documents to delete from the index.

Returns:

One or more identifiers for documents to delete from the index.

setDocumentIdList

public void setDocumentIdList(Collection<String> documentIdList)

One or more identifiers for documents to delete from the index.

Parameters:

documentIdList - One or more identifiers for documents to delete from the index.

withDocumentIdList

public BatchDeleteDocumentRequest withDocumentIdList(String... documentIdList)

One or more identifiers for documents to delete from the index.

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

Parameters:

documentIdList - One or more identifiers for documents to delete from the index.

Returns:

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

withDocumentIdList

public BatchDeleteDocumentRequest withDocumentIdList(Collection<String> documentIdList)

One or more identifiers for documents to delete from the index.

Parameters:

documentIdList - One or more identifiers for documents to delete from the index.

Returns:

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

setDataSourceSyncJobMetricTarget

public void setDataSourceSyncJobMetricTarget(DataSourceSyncJobMetricTarget dataSourceSyncJobMetricTarget)

Parameters:

dataSourceSyncJobMetricTarget -

getDataSourceSyncJobMetricTarget

public DataSourceSyncJobMetricTarget getDataSourceSyncJobMetricTarget()

Returns:

withDataSourceSyncJobMetricTarget

public BatchDeleteDocumentRequest withDataSourceSyncJobMetricTarget(DataSourceSyncJobMetricTarget dataSourceSyncJobMetricTarget)

Parameters:

dataSourceSyncJobMetricTarget -

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