software.amazon.awssdk.services.kendra.model

Class BatchDeleteDocumentRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchDeleteDocumentRequest.Builder,BatchDeleteDocumentRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class BatchDeleteDocumentRequest
extends KendraRequest
implements ToCopyableBuilder<BatchDeleteDocumentRequest.Builder,BatchDeleteDocumentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchDeleteDocumentRequest.Builder

Method Summary

Modifier and Type	Method and Description
static BatchDeleteDocumentRequest.Builder	builder()
DataSourceSyncJobMetricTarget	dataSourceSyncJobMetricTarget() Returns the value of the DataSourceSyncJobMetricTarget property for this object.
List<String>	documentIdList() One or more identifiers for documents to delete from the index.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDocumentIdList() Returns true if the DocumentIdList 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 that contains the documents to delete.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchDeleteDocumentRequest.Builder>	serializableBuilderClass()
BatchDeleteDocumentRequest.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 that contains the documents to delete.

Returns:

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

hasDocumentIdList

public boolean hasDocumentIdList()

Returns true if the DocumentIdList 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.

documentIdList

public List<String> documentIdList()

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

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

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

Returns:

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

dataSourceSyncJobMetricTarget

public DataSourceSyncJobMetricTarget dataSourceSyncJobMetricTarget()

Returns the value of the DataSourceSyncJobMetricTarget property for this object.

Returns:

The value of the DataSourceSyncJobMetricTarget property for this object.

toBuilder

public BatchDeleteDocumentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchDeleteDocumentRequest.Builder,BatchDeleteDocumentRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static BatchDeleteDocumentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends BatchDeleteDocumentRequest.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