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

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

The long-running operation metadata for BatchProcessDocuments.

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

Namespace

Google \ Cloud \ DocumentAI \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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.

getState

The state of the current batch processing.

Returns
TypeDescription
int

setState

The state of the current batch processing.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStateMessage

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

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

Returns
TypeDescription
string

setStateMessage

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

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

The creation time of the operation.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The creation time of the operation.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

The last update time of the operation.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

The last update time of the operation.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getIndividualProcessStatuses

The list of response details of each document.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setIndividualProcessStatuses

The list of response details of each document.

Parameter
NameDescription
var array<Google\Cloud\DocumentAI\V1\BatchProcessMetadata\IndividualProcessStatus>
Returns
TypeDescription
$this