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

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

Methods

__construct

Constructor.

Parameters
NameDescription
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. The batch process is started by take snapshot of that document, since a user can move or change that document during the process.

↳ status Google\Rpc\Status

The status processing the document.

↳ output_gcs_destination string

The output_gcs_destination (in the request as output_gcs_destination) 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. The batch process is started by take snapshot of that document, since a user can move or change that document during the process.

Generated from protobuf field string input_gcs_source = 1;

Returns
TypeDescription
string

setInputGcsSource

The source of the document, same as the [input_gcs_source] field in the request when the batch process started. The batch process is started by take snapshot of that document, since a user can move or change that document during the process.

Generated from protobuf field string input_gcs_source = 1;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStatus

The status processing the document.

Generated from protobuf field .google.rpc.Status status = 2;

Returns
TypeDescription
Google\Rpc\Status|null

hasStatus

clearStatus

setStatus

The status processing the document.

Generated from protobuf field .google.rpc.Status status = 2;

Parameter
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$this

getOutputGcsDestination

The output_gcs_destination (in the request as output_gcs_destination) of the processed document if it was successful, otherwise empty.

Generated from protobuf field string output_gcs_destination = 3;

Returns
TypeDescription
string

setOutputGcsDestination

The output_gcs_destination (in the request as output_gcs_destination) of the processed document if it was successful, otherwise empty.

Generated from protobuf field string output_gcs_destination = 3;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getHumanReviewStatus

The status of human review on the processed document.

Generated from protobuf field .google.cloud.documentai.v1.HumanReviewStatus human_review_status = 5;

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\HumanReviewStatus|null

hasHumanReviewStatus

clearHumanReviewStatus

setHumanReviewStatus

The status of human review on the processed document.

Generated from protobuf field .google.cloud.documentai.v1.HumanReviewStatus human_review_status = 5;

Parameter
NameDescription
var Google\Cloud\DocumentAI\V1\HumanReviewStatus
Returns
TypeDescription
$this