Package software.amazon.awssdk.services.textract.model

Class DocumentLocation

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

The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations.

The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.

See Also:

  • Method Details

    • s3Object

      public final S3Object s3Object()

      The Amazon S3 bucket that contains the input document.

      Returns:
      The Amazon S3 bucket that contains the input document.

    • toBuilder

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

    • builder

      public static DocumentLocation.Builder builder()

    • serializableBuilderClass

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