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

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

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

getState

The state of the operation.

Returns
TypeDescription
int

setState

The state of the operation.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStateMessage

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

Returns
TypeDescription
string

setStateMessage

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getResource

A related resource to this operation.

Returns
TypeDescription
string

setResource

A related resource to this operation.

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