Class ErrorsListItem

java.lang.Object
software.amazon.awssdk.services.comprehend.model.ErrorsListItem
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ErrorsListItem.Builder,ErrorsListItem>
@Generated("software.amazon.awssdk:codegen") public final class ErrorsListItem extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ErrorsListItem.Builder,ErrorsListItem>

Text extraction encountered one or more page-level errors in the input document.

The ErrorCode contains one of the following values:

  • TEXTRACT_BAD_PAGE - Amazon Textract cannot read the page. For more information about page limits in Amazon Textract, see Page Quotas in Amazon Textract.

  • TEXTRACT_PROVISIONED_THROUGHPUT_EXCEEDED - The number of requests exceeded your throughput limit. For more information about throughput quotas in Amazon Textract, see Default quotas in Amazon Textract.

  • PAGE_CHARACTERS_EXCEEDED - Too many text characters on the page (10,000 characters maximum).

  • PAGE_SIZE_EXCEEDED - The maximum page size is 10 MB.

  • INTERNAL_SERVER_ERROR - The request encountered a service issue. Try the API request again.

See Also:

  • Method Details

    • page

      public final Integer page()

      Page number where the error occurred.

      Returns:
      Page number where the error occurred.

    • errorCode

      public final PageBasedErrorCode errorCode()

      Error code for the cause of the error.

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

      Returns:
      Error code for the cause of the error.
      See Also:

    • errorCodeAsString

      public final String errorCodeAsString()

      Error code for the cause of the error.

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

      Returns:
      Error code for the cause of the error.
      See Also:

    • errorMessage

      public final String errorMessage()

      Text message explaining the reason for the error.

      Returns:
      Text message explaining the reason for the error.

    • toBuilder

      public ErrorsListItem.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<ErrorsListItem.Builder,ErrorsListItem>
      Returns:
      a builder for type T

    • builder

      public static ErrorsListItem.Builder builder()

    • serializableBuilderClass

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