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

Class BatchPutDocumentResponseFailedDocument

java.lang.Object

software.amazon.awssdk.services.kendra.model.BatchPutDocumentResponseFailedDocument

All Implemented Interfaces:

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

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

Provides information about a document that could not be indexed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchPutDocumentResponseFailedDocument.Builder

Method Summary

Modifier and Type	Method	Description
static BatchPutDocumentResponseFailedDocument.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorCode	errorCode()	The type of error that caused the document to fail to be indexed.
String	errorCodeAsString()	The type of error that caused the document to fail to be indexed.
String	errorMessage()	A description of the reason why the document could not be indexed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The identifier of the document.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchPutDocumentResponseFailedDocument.Builder>	serializableBuilderClass()
BatchPutDocumentResponseFailedDocument.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.

Returns:

The identifier of the document.

errorCode

public final ErrorCode errorCode()

The type of error that caused the document to fail to be indexed.

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 type of error that caused the document to fail to be indexed.

See Also:

ErrorCode

errorCodeAsString

public final String errorCodeAsString()

The type of error that caused the document to fail to be indexed.

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 type of error that caused the document to fail to be indexed.

See Also:

ErrorCode

errorMessage

public final String errorMessage()

A description of the reason why the document could not be indexed.

Returns:

A description of the reason why the document could not be indexed.

toBuilder

public BatchPutDocumentResponseFailedDocument.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchPutDocumentResponseFailedDocument.Builder,BatchPutDocumentResponseFailedDocument>

builder

public static BatchPutDocumentResponseFailedDocument.Builder builder()

serializableBuilderClass

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