Package software.amazon.awssdk.services.kendra.model

Class BatchDeleteDocumentResponseFailedDocument

java.lang.Object

software.amazon.awssdk.services.kendra.model.BatchDeleteDocumentResponseFailedDocument

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BatchDeleteDocumentResponseFailedDocument.Builder,BatchDeleteDocumentResponseFailedDocument>

@Generated("software.amazon.awssdk:codegen")
public final class BatchDeleteDocumentResponseFailedDocument
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BatchDeleteDocumentResponseFailedDocument.Builder,BatchDeleteDocumentResponseFailedDocument>

Provides information about documents that could not be removed from an index by the BatchDeleteDocument API.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchDeleteDocumentResponseFailedDocument.Builder

Method Summary

Modifier and Type	Method	Description
static BatchDeleteDocumentResponseFailedDocument.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorCode	errorCode()	The error code for why the document couldn't be removed from the index.
String	errorCodeAsString()	The error code for why the document couldn't be removed from the index.
String	errorMessage()	An explanation for why the document couldn't be removed from the index.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The identifier of the document that couldn't be removed from the index.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchDeleteDocumentResponseFailedDocument.Builder>	serializableBuilderClass()
BatchDeleteDocumentResponseFailedDocument.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

id

public final String id()

The identifier of the document that couldn't be removed from the index.

Returns:

The identifier of the document that couldn't be removed from the index.

errorCode

public final ErrorCode errorCode()

The error code for why the document couldn't be removed from the index.

If the service returns an enum value that is not available in the current SDK version, errorCode will return ErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorCodeAsString().

Returns:

The error code for why the document couldn't be removed from the index.

See Also:

ErrorCode

errorCodeAsString

public final String errorCodeAsString()

The error code for why the document couldn't be removed from the index.

If the service returns an enum value that is not available in the current SDK version, errorCode will return ErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from errorCodeAsString().

Returns:

The error code for why the document couldn't be removed from the index.

See Also:

ErrorCode

errorMessage

public final String errorMessage()

An explanation for why the document couldn't be removed from the index.

Returns:

An explanation for why the document couldn't be removed from the index.

toBuilder

public BatchDeleteDocumentResponseFailedDocument.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchDeleteDocumentResponseFailedDocument.Builder,BatchDeleteDocumentResponseFailedDocument>

builder

public static BatchDeleteDocumentResponseFailedDocument.Builder builder()

serializableBuilderClass

public static Class<? extends BatchDeleteDocumentResponseFailedDocument.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo