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

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

The common metadata for long running operations.

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

Methods

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ state
int

The state of the operation.

↳ state_message
string

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

↳ resource
string

A related resource to this operation.

↳ create_time
Google\Protobuf\Timestamp

The creation time of the operation.

↳ update_time
Google\Protobuf\Timestamp

The last update time of the operation.

The state of the operation.

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

Returns
Type
Description
int

The state of the operation.

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

Parameter
Name
Description
var
int
Returns
Type
Description
$this

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

Generated from protobuf field string state_message = 2;

Returns
Type
Description
string

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

Generated from protobuf field string state_message = 2;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

A related resource to this operation.

Generated from protobuf field string resource = 5;

Returns
Type
Description
string

A related resource to this operation.

Generated from protobuf field string resource = 5;

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
Design a Mobile Site
View Site in Mobile | Classic
Share by: