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

Class BatchGetDocumentStatusResponseError

java.lang.Object

software.amazon.awssdk.services.kendra.model.BatchGetDocumentStatusResponseError

All Implemented Interfaces:

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

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

Provides a response when the status of a document could not be retrieved.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchGetDocumentStatusResponseError.Builder

Method Summary

Modifier and Type	Method	Description
static BatchGetDocumentStatusResponseError.Builder	builder()
String	documentId()	The identifier of the document whose status could not be retrieved.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorCode	errorCode()	Indicates the source of the error.
String	errorCodeAsString()	Indicates the source of the error.
String	errorMessage()	States that the API could not get the status of a document.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends BatchGetDocumentStatusResponseError.Builder>	serializableBuilderClass()
BatchGetDocumentStatusResponseError.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

documentId

public final String documentId()

The identifier of the document whose status could not be retrieved.

Returns:

The identifier of the document whose status could not be retrieved.

errorCode

public final ErrorCode errorCode()

Indicates the source of the error.

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:

Indicates the source of the error.

See Also:

ErrorCode

errorCodeAsString

public final String errorCodeAsString()

Indicates the source of the error.

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:

Indicates the source of the error.

See Also:

ErrorCode

errorMessage

public final String errorMessage()

States that the API could not get the status of a document. This could be because the request is not valid or there is a system error.

Returns:

States that the API could not get the status of a document. This could be because the request is not valid or there is a system error.

toBuilder

public BatchGetDocumentStatusResponseError.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchGetDocumentStatusResponseError.Builder,BatchGetDocumentStatusResponseError>

builder

public static BatchGetDocumentStatusResponseError.Builder builder()

serializableBuilderClass

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