Class Status
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Status.Builder,
Status>
Provides information about the status of documents submitted for indexing.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Status.Builder
builder()
final String
The identifier of the document.final DocumentStatus
The current status of a document.final String
The current status of a document.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Indicates the source of the error.final String
Provides detailed information about why the document couldn't be indexed.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends Status.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
documentId
The identifier of the document.
- Returns:
- The identifier of the document.
-
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 returnDocumentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdocumentStatusAsString()
.- 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:
-
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 returnDocumentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdocumentStatusAsString()
.- 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:
-
failureCode
Indicates the source of the error.
- Returns:
- Indicates the source of the error.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Status.Builder,
Status> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-