Google Cloud Ces V1 Client - Class OperationMetadata (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class OperationMetadata.

Represents the metadata of the long-running operation.

Generated from protobuf message google.cloud.ces.v1.OperationMetadata

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ create_time Google\Protobuf\Timestamp

Output only. The time the operation was created.

↳ end_time Google\Protobuf\Timestamp

Output only. The time the operation finished running.

↳ status_message string

Output only. Human-readable status of the operation, if any.

↳ requested_cancellation bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

getCreateTime

Output only. The time the operation was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time the operation was created.

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

getEndTime

Output only. The time the operation finished running.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Output only. The time the operation finished running.

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

getStatusMessage

Output only. Human-readable status of the operation, if any.

Returns
Type Description
string

setStatusMessage

Output only. Human-readable status of the operation, if any.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestedCancellation

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Returns
Type Description
bool

setRequestedCancellation

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameter
Name Description
var bool
Returns
Type Description
$this