Google Cloud Apigee Registry V1 Client - Class OperationMetadata (0.5.5)

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

Represents the metadata of the long-running operation.

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

Namespace

Google \ Cloud \ ApigeeRegistry \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ create_time Google\Protobuf\Timestamp

The time the operation was created.

↳ end_time Google\Protobuf\Timestamp

The time the operation finished running.

↳ target string

Server-defined resource path for the target of the operation.

↳ verb string

Name of the verb executed by the operation.

↳ status_message string

Human-readable status of the operation, if any.

↳ cancellation_requested bool

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

↳ api_version string

API version used to start the operation.

getCreateTime

The time the operation was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The time the operation was created.

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

getEndTime

The time the operation finished running.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

The time the operation finished running.

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

getTarget

Server-defined resource path for the target of the operation.

Returns
Type Description
string

setTarget

Server-defined resource path for the target of the operation.

Parameter
Name Description
var string
Returns
Type Description
$this

getVerb

Name of the verb executed by the operation.

Returns
Type Description
string

setVerb

Name of the verb executed by the operation.

Parameter
Name Description
var string
Returns
Type Description
$this

getStatusMessage

Human-readable status of the operation, if any.

Returns
Type Description
string

setStatusMessage

Human-readable status of the operation, if any.

Parameter
Name Description
var string
Returns
Type Description
$this

getCancellationRequested

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

Returns
Type Description
bool

setCancellationRequested

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getApiVersion

API version used to start the operation.

Returns
Type Description
string

setApiVersion

API version used to start the operation.

Parameter
Name Description
var string
Returns
Type Description
$this