Google Cloud Document Ai V1 Client - Class IndividualProcessStatus (1.12.2)

Reference documentation and code samples for the Google Cloud Document Ai V1 Client class IndividualProcessStatus.

The status of a each individual document in the batch process.

Generated from protobuf message google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus

Namespace

Google \ Cloud \ DocumentAI \ V1 \ BatchProcessMetadata

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ input_gcs_source string

The source of the document, same as the input_gcs_source field in the request when the batch process started.

↳ status Google\Rpc\Status

The status processing the document.

↳ output_gcs_destination string

The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.

↳ human_review_status Google\Cloud\DocumentAI\V1\HumanReviewStatus

The status of human review on the processed document.

getInputGcsSource

The source of the document, same as the input_gcs_source field in the request when the batch process started.

Returns
Type Description
string

setInputGcsSource

The source of the document, same as the input_gcs_source field in the request when the batch process started.

Parameter
Name Description
var string
Returns
Type Description
$this

getStatus

The status processing the document.

Returns
Type Description
Google\Rpc\Status|null

hasStatus

clearStatus

setStatus

The status processing the document.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$this

getOutputGcsDestination

The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.

Returns
Type Description
string

setOutputGcsDestination

The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.

Parameter
Name Description
var string
Returns
Type Description
$this

getHumanReviewStatus

The status of human review on the processed document.

Returns
Type Description
Google\Cloud\DocumentAI\V1\HumanReviewStatus|null

hasHumanReviewStatus

clearHumanReviewStatus

setHumanReviewStatus

The status of human review on the processed document.

Parameter
Name Description
var Google\Cloud\DocumentAI\V1\HumanReviewStatus
Returns
Type Description
$this