Package 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("software.amazon.awssdk:codegen")
public final class BatchDeleteDocumentRequest
extends KendraRequest
implements ToCopyableBuilder<BatchDeleteDocumentRequest.Builder,BatchDeleteDocumentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchDeleteDocumentRequest.Builder

Method Summary

Modifier and Type	Method	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()	For responses, this returns true if the service returned a value for the DocumentIdList property.
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 final 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 final boolean hasDocumentIdList()

For responses, this returns true if the service returned a value for the DocumentIdList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

documentIdList

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDocumentIdList() method.

Returns:

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

dataSourceSyncJobMetricTarget

public final 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 final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo