Class ExpenseField
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ExpenseField.Builder,
ExpenseField>
Breakdown of detected information, seperated into the catagories Type, LabelDetection, and ValueDetection
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ExpenseField.Builder
builder()
final ExpenseCurrency
currency()
Shows the kind of currency, both the code and confidence associated with any monatary value detected.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final List
<ExpenseGroupProperty> Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.final boolean
For responses, this returns true if the service returned a value for the GroupProperties property.final int
hashCode()
final ExpenseDetection
The explicitly stated label of a detected element.final Integer
The page number the value was detected on.static Class
<? extends ExpenseField.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final ExpenseType
type()
The implied label of a detected element.final ExpenseDetection
The value of a detected element.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
The implied label of a detected element. Present alongside LabelDetection for explicit elements.
- Returns:
- The implied label of a detected element. Present alongside LabelDetection for explicit elements.
-
labelDetection
The explicitly stated label of a detected element.
- Returns:
- The explicitly stated label of a detected element.
-
valueDetection
The value of a detected element. Present in explicit and implicit elements.
- Returns:
- The value of a detected element. Present in explicit and implicit elements.
-
pageNumber
The page number the value was detected on.
- Returns:
- The page number the value was detected on.
-
currency
Shows the kind of currency, both the code and confidence associated with any monatary value detected.
- Returns:
- Shows the kind of currency, both the code and confidence associated with any monatary value detected.
-
hasGroupProperties
public final boolean hasGroupProperties()For responses, this returns true if the service returned a value for the GroupProperties 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. -
groupProperties
Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.
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
hasGroupProperties()
method.- Returns:
- Shows which group a response object belongs to, such as whether an address line belongs to the vendor's address or the recipent's address.
-
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 interfaceToCopyableBuilder<ExpenseField.Builder,
ExpenseField> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-