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

Class ExpenseDocument

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

The structure holding all the information returned by AnalyzeExpense

See Also:

  • Method Details

    • expenseIndex

      public final Integer expenseIndex()

      Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.

      Returns:
      Denotes which invoice or receipt in the document the information is coming from. First document will be 1, the second 2, and so on.

    • hasSummaryFields

      public final boolean hasSummaryFields()
      For responses, this returns true if the service returned a value for the SummaryFields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • summaryFields

      public final List<ExpenseField> summaryFields()

      Any information found outside of a table by Amazon Textract.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSummaryFields() method.

      Returns:
      Any information found outside of a table by Amazon Textract.

    • hasLineItemGroups

      public final boolean hasLineItemGroups()
      For responses, this returns true if the service returned a value for the LineItemGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • lineItemGroups

      public final List<LineItemGroup> lineItemGroups()

      Information detected on each table of a document, seperated into LineItems.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLineItemGroups() method.

      Returns:
      Information detected on each table of a document, seperated into LineItems.

    • hasBlocks

      public final boolean hasBlocks()
      For responses, this returns true if the service returned a value for the Blocks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • blocks

      public final List<Block> blocks()

      This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBlocks() method.

      Returns:
      This is a block object, the same as reported when DetectDocumentText is run on a document. It provides word level recognition of text.

    • toBuilder

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

    • builder

      public static ExpenseDocument.Builder builder()

    • serializableBuilderClass

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