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
Namespace
Google \ Cloud \ DocumentAI \ V1Methods
__construct
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. |
getState
The state of the current batch processing.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
The state of the current batch processing.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStateMessage
A message providing more details about the current state of processing.
For example, the error message if the operation is failed.
| Returns | |
|---|---|
| Type | Description |
string | |
setStateMessage
A message providing more details about the current state of processing.
For example, the error message if the operation is failed.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
The creation time of the operation.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
The creation time of the operation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
The last update time of the operation.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
The last update time of the operation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIndividualProcessStatuses
The list of response details of each document.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setIndividualProcessStatuses
The list of response details of each document.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\DocumentAI\V1\BatchProcessMetadata\IndividualProcessStatus>
|
| Returns | |
|---|---|
| Type | Description |
$this | |