Class GetExpenseAnalysisResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetExpenseAnalysisResponse.Builder,
GetExpenseAnalysisResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
The current model version of AnalyzeExpense.builder()
final DocumentMetadata
Information about a document that Amazon Textract processed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<ExpenseDocument> The expenses detected by Amazon Textract.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the ExpenseDocuments property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Warnings property.final JobStatus
The current status of the text detection job.final String
The current status of the text detection job.final String
If the response is truncated, Amazon Textract returns this token.static Class
<? extends GetExpenseAnalysisResponse.Builder> final String
Returns if the detection job could not be completed.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.warnings()
A list of warnings that occurred during the text-detection operation for the document.Methods inherited from class software.amazon.awssdk.services.textract.model.TextractResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
documentMetadata
Information about a document that Amazon Textract processed.
DocumentMetadata
is returned in every page of paginated responses from an Amazon Textract operation.- Returns:
- Information about a document that Amazon Textract processed.
DocumentMetadata
is returned in every page of paginated responses from an Amazon Textract operation.
-
jobStatus
The current status of the text detection job.
If the service returns an enum value that is not available in the current SDK version,
jobStatus
will returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobStatusAsString()
.- Returns:
- The current status of the text detection job.
- See Also:
-
jobStatusAsString
The current status of the text detection job.
If the service returns an enum value that is not available in the current SDK version,
jobStatus
will returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobStatusAsString()
.- Returns:
- The current status of the text detection job.
- See Also:
-
nextToken
If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.
- Returns:
- If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.
-
hasExpenseDocuments
public final boolean hasExpenseDocuments()For responses, this returns true if the service returned a value for the ExpenseDocuments 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. -
expenseDocuments
The expenses detected 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
hasExpenseDocuments()
method.- Returns:
- The expenses detected by Amazon Textract.
-
hasWarnings
public final boolean hasWarnings()For responses, this returns true if the service returned a value for the Warnings 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. -
warnings
A list of warnings that occurred during the text-detection operation for the document.
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
hasWarnings()
method.- Returns:
- A list of warnings that occurred during the text-detection operation for the document.
-
statusMessage
Returns if the detection job could not be completed. Contains explanation for what error occured.
- Returns:
- Returns if the detection job could not be completed. Contains explanation for what error occured.
-
analyzeExpenseModelVersion
The current model version of AnalyzeExpense.
- Returns:
- The current model version of AnalyzeExpense.
-
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<GetExpenseAnalysisResponse.Builder,
GetExpenseAnalysisResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
-
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-