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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<Status.Builder,Status>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.