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:

  • Method Details

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

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

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

    • 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)
      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.