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

Class Status

java.lang.Object

software.amazon.awssdk.services.kendra.model.Status

All Implemented Interfaces:

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

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

Provides information about the status of documents submitted for indexing.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Status.Builder

Method Summary

Modifier and Type	Method	Description
static Status.Builder	builder()
String	documentId()	The identifier of the document.
DocumentStatus	documentStatus()	The current status of a document.
String	documentStatusAsString()	The current status of a document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureCode()	Indicates the source of the error.
String	failureReason()	Provides detailed information about why the document couldn't be indexed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends Status.Builder>	serializableBuilderClass()
Status.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.

Returns:

The identifier of the document.

documentStatus

public final DocumentStatus documentStatus()

The current status of a document.

If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

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

Returns:

The current status of a document.

If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

See Also:

DocumentStatus

documentStatusAsString

public final String documentStatusAsString()

The current status of a document.

If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

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

Returns:

The current status of a document.

If the document was submitted for deletion, the status is NOT_FOUND after the document is deleted.

See Also:

DocumentStatus

failureCode

public final String failureCode()

Indicates the source of the error.

Returns:

Indicates the source of the error.

failureReason

public final String failureReason()

Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

Returns:

Provides detailed information about why the document couldn't be indexed. Use this information to correct the error before you resubmit the document for indexing.

toBuilder

public Status.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Status.Builder,Status>

builder

public static Status.Builder builder()

serializableBuilderClass

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