Reference documentation and code samples for the Google Cloud Run V2 Client class CancelExecutionRequest.
Request message for deleting an Execution.
Generated from protobuf messagegoogle.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 seeExecutionsClient::executionName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Run V2 Client - Class CancelExecutionRequest (1.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.9.0 (latest)](/php/docs/reference/cloud-run/latest/V2.CancelExecutionRequest)\n- [1.8.0](/php/docs/reference/cloud-run/1.8.0/V2.CancelExecutionRequest)\n- [1.7.0](/php/docs/reference/cloud-run/1.7.0/V2.CancelExecutionRequest)\n- [1.6.0](/php/docs/reference/cloud-run/1.6.0/V2.CancelExecutionRequest)\n- [1.5.2](/php/docs/reference/cloud-run/1.5.2/V2.CancelExecutionRequest)\n- [1.4.0](/php/docs/reference/cloud-run/1.4.0/V2.CancelExecutionRequest)\n- [1.3.0](/php/docs/reference/cloud-run/1.3.0/V2.CancelExecutionRequest)\n- [1.2.0](/php/docs/reference/cloud-run/1.2.0/V2.CancelExecutionRequest)\n- [1.1.0](/php/docs/reference/cloud-run/1.1.0/V2.CancelExecutionRequest)\n- [1.0.0](/php/docs/reference/cloud-run/1.0.0/V2.CancelExecutionRequest)\n- [0.9.3](/php/docs/reference/cloud-run/0.9.3/V2.CancelExecutionRequest)\n- [0.8.0](/php/docs/reference/cloud-run/0.8.0/V2.CancelExecutionRequest)\n- [0.7.2](/php/docs/reference/cloud-run/0.7.2/V2.CancelExecutionRequest)\n- [0.6.0](/php/docs/reference/cloud-run/0.6.0/V2.CancelExecutionRequest)\n- [0.5.2](/php/docs/reference/cloud-run/0.5.2/V2.CancelExecutionRequest)\n- [0.4.0](/php/docs/reference/cloud-run/0.4.0/V2.CancelExecutionRequest)\n- [0.3.4](/php/docs/reference/cloud-run/0.3.4/V2.CancelExecutionRequest) \nReference documentation and code samples for the Google Cloud Run V2 Client class CancelExecutionRequest.\n\nRequest message for deleting an Execution.\n\nGenerated from protobuf message `google.cloud.run.v2.CancelExecutionRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Run \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The name of the Execution to cancel.\n\nFormat:\n`projects/{project}/locations/{location}/jobs/{job}/executions/{execution}`,\nwhere `{project}` can be project id or number.\n\n### setName\n\nRequired. The name of the Execution to cancel.\n\nFormat:\n`projects/{project}/locations/{location}/jobs/{job}/executions/{execution}`,\nwhere `{project}` can be project id or number.\n\n### getValidateOnly\n\nIndicates that the request should be validated without actually\ncancelling any resources.\n\n### setValidateOnly\n\nIndicates that the request should be validated without actually\ncancelling any resources.\n\n### getEtag\n\nA system-generated fingerprint for this version of the resource.\n\nThis may be used to detect modification conflict during updates.\n\n### setEtag\n\nA system-generated fingerprint for this version of the resource.\n\nThis may be used to detect modification conflict during updates.\n\n### static::build"]]
