Google Cloud Workflows V1 Client - Class CancelExecutionRequest (0.5.0)

Version 0.5.0

• 0.5.4 (latest)
• 0.5.3
• 0.4.2
• 0.3.0
• 0.2.17

Reference documentation and code samples for the Google Cloud Workflows V1 Client class CancelExecutionRequest.

Request for the CancelExecution method.

Generated from protobuf message google.cloud.workflows.executions.v1.CancelExecutionRequest

Namespace

Google \ Cloud \ Workflows \ Executions \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

getName

Required. Name of the execution to be cancelled.

Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

Returns
Type	Description
string

setName

Required. Name of the execution to be cancelled.

Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
name	string Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} Please see Google\Cloud\Workflows\Executions\V1\ExecutionsClient::executionName() for help formatting this field.

Returns
Type	Description
Google\Cloud\Workflows\Executions\V1\CancelExecutionRequest