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

Class GetExpenseAnalysisResponse

    • Method Detail

      • documentMetadata

        public final DocumentMetadata 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

        public final JobStatus 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 return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

        Returns:
        The current status of the text detection job.
        See Also:
        JobStatus

      • jobStatusAsString

        public final String 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 return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

        Returns:
        The current status of the text detection job.
        See Also:
        JobStatus

      • nextToken

        public final String 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 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.

      • expenseDocuments

        public final List<ExpenseDocument> 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 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.

      • warnings

        public final List<Warning> 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

        public final String 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

        public final String analyzeExpenseModelVersion()

        The current model version of AnalyzeExpense.

        Returns:
        The current model version of AnalyzeExpense.

      • 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