Google Cloud Run V2 Client - Class CancelExecutionRequest (0.9.2)

Reference documentation and code samples for the Google Cloud Run V2 Client class CancelExecutionRequest.

Request message for deleting an Execution.

Generated from protobuf message google.cloud.run.v2.CancelExecutionRequest

Namespace

Google \ Cloud \ Run \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The name of the Execution to cancel. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}, where {project} can be project id or number.
↳ validate_only bool

Indicates that the request should be validated without actually cancelling any resources.
↳ etag string

A system-generated fingerprint for this version of the resource. This may be used to detect modification conflict during updates.

getName

Required. The name of the Execution to cancel.

Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}, where {project} can be project id or number.

Returns
Type Description
string

setName

Required. The name of the Execution to cancel.

Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}, where {project} can be project id or number.

Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

Indicates that the request should be validated without actually cancelling any resources.

Returns
Type Description
bool

setValidateOnly

Indicates that the request should be validated without actually cancelling any resources.

Parameter
Name Description
var bool
Returns
Type Description
$this

getEtag

A system-generated fingerprint for this version of the resource.

This may be used to detect modification conflict during updates.

Returns
Type Description
string

setEtag

A system-generated fingerprint for this version of the resource.

This may be used to detect modification conflict during updates.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the Execution to cancel. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}, where {project} can be project id or number. Please see Google\Cloud\Run\V2\ExecutionsClient::executionName() for help formatting this field.
Returns
Type Description
Google\Cloud\Run\V2\CancelExecutionRequest