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

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

The long running operation metadata for batch process method.

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

Methods

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ state
int

The state of the current batch processing.

↳ state_message
string

A message providing more details about the current state of processing. For example, the error message if the operation is failed.

↳ create_time
Google\Protobuf\Timestamp

The creation time of the operation.

↳ update_time
Google\Protobuf\Timestamp

The last update time of the operation.

↳ individual_process_statuses
array< Google\Cloud\DocumentAI\V1\BatchProcessMetadata\IndividualProcessStatus >

The list of response details of each document.

The state of the current batch processing.

Generated from protobuf field .google.cloud.documentai.v1.BatchProcessMetadata.State state = 1;

Returns
Type
Description
int

The state of the current batch processing.

Generated from protobuf field .google.cloud.documentai.v1.BatchProcessMetadata.State state = 1;

Parameter
Name
Description
var
int
Returns
Type
Description
$this

A message providing more details about the current state of processing.

For example, the error message if the operation is failed.

Generated from protobuf field string state_message = 2;

Returns
Type
Description
string

A message providing more details about the current state of processing.

For example, the error message if the operation is failed.

Generated from protobuf field string state_message = 2;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

The creation time of the operation.

Generated from protobuf field .google.protobuf.Timestamp create_time = 3;

Returns
Type
Description
Google\Protobuf\Timestamp|null

The creation time of the operation.

Generated from protobuf field .google.protobuf.Timestamp create_time = 3;

Parameter
Name
Description
var
Google\Protobuf\Timestamp
Returns
Type
Description
$this

The last update time of the operation.

Generated from protobuf field .google.protobuf.Timestamp update_time = 4;

Returns
Type
Description
Google\Protobuf\Timestamp|null

The last update time of the operation.

Generated from protobuf field .google.protobuf.Timestamp update_time = 4;

Parameter
Name
Description
var
Google\Protobuf\Timestamp
Returns
Type
Description
$this

The list of response details of each document.

Generated from protobuf field repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

The list of response details of each document.

Generated from protobuf field repeated .google.cloud.documentai.v1.BatchProcessMetadata.IndividualProcessStatus individual_process_statuses = 5;

Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: