Google Cloud Functions V2 Client - Class OperationMetadata (1.0.3)

Reference documentation and code samples for the Google Cloud Functions V2 Client class OperationMetadata.

Represents the metadata of the long-running operation.

Generated from protobuf message google.cloud.functions.v2.OperationMetadata

Methods

__construct

Constructor.

Parameters
NameDescription
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_detail string

Human-readable status of the operation, if any.

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

↳ request_resource Google\Protobuf\Any

The original request that started the operation.

↳ stages array<Google\Cloud\Functions\V2\Stage>

Mechanism for reporting in-progress stages

getCreateTime

The time the operation was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The time the operation was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

The time the operation finished running.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

The time the operation finished running.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getTarget

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

Returns
TypeDescription
string

setTarget

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVerb

Name of the verb executed by the operation.

Returns
TypeDescription
string

setVerb

Name of the verb executed by the operation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStatusDetail

Human-readable status of the operation, if any.

Returns
TypeDescription
string

setStatusDetail

Human-readable status of the operation, if any.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCancelRequested

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
TypeDescription
bool

setCancelRequested

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
NameDescription
var bool
Returns
TypeDescription
$this

getApiVersion

API version used to start the operation.

Returns
TypeDescription
string

setApiVersion

API version used to start the operation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRequestResource

The original request that started the operation.

Returns
TypeDescription
Google\Protobuf\Any|null

hasRequestResource

clearRequestResource

setRequestResource

The original request that started the operation.

Parameter
NameDescription
var Google\Protobuf\Any
Returns
TypeDescription
$this

getStages

Mechanism for reporting in-progress stages

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setStages

Mechanism for reporting in-progress stages

Parameter
NameDescription
var array<Google\Cloud\Functions\V2\Stage>
Returns
TypeDescription
$this