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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ExpenseDocument.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<Block>
blocks()
This is a block object, the same as reported when DetectDocumentText is run on a document.static ExpenseDocument.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
Integer
expenseIndex()
Denotes which invoice or receipt in the document the information is coming from.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasBlocks()
For responses, this returns true if the service returned a value for the Blocks property.int
hashCode()
boolean
hasLineItemGroups()
For responses, this returns true if the service returned a value for the LineItemGroups property.boolean
hasSummaryFields()
For responses, this returns true if the service returned a value for the SummaryFields property.List<LineItemGroup>
lineItemGroups()
Information detected on each table of a document, seperated intoLineItems
.List<SdkField<?>>
sdkFields()
static Class<? extends ExpenseDocument.Builder>
serializableBuilderClass()
List<ExpenseField>
summaryFields()
Any information found outside of a table by Amazon Textract.ExpenseDocument.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()
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 theisEmpty()
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 theisEmpty()
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ExpenseDocument.Builder,ExpenseDocument>
-
builder
public static ExpenseDocument.Builder builder()
-
serializableBuilderClass
public static Class<? extends ExpenseDocument.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-