Method: googleapis.run.v1.namespaces.executions.cancel

Cancel an execution.

This method waits—the workflow execution is paused—until the operation is complete, fails, or times out. The default timeout value is 1800 seconds (30 minutes) and can be changed to a maximum value of 31536000 seconds (one year) for long-running operations using the connector_params field. See the Connectors reference.

The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.

The polling policy for the long-running operation can be configured. To set the connector-specific parameters (connector_params), refer to Invoke a connector call.

Arguments

Parameters

Parameters
`name`	`string` Required. The name of the execution to cancel. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID
`location`	`string` Location of the HTTP endpoint. For example, `us-central1` or `asia-southeast1`. If not set, the global endpoint https://run.googleapis.com will be used, which supports list methods only. See service endpoints for more location options.

name

string

Required. The name of the execution to cancel. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID

location

string

Location of the HTTP endpoint. For example, us-central1 or asia-southeast1. If not set, the global endpoint https://run.googleapis.com will be used, which supports list methods only. See service endpoints for more location options.

Raised exceptions

Exceptions
`ConnectionError`	In case of a network problem (such as DNS failure or refused connection).
`HttpError`	If the response status is >= 400 (excluding 429 and 503).
`TimeoutError`	If a long-running operation takes longer to finish than the specified timeout limit.
`TypeError`	If an operation or function receives an argument of the wrong type.
`ValueError`	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
`OperationError`	If the long-running operation finished unsuccessfully.
`ResponseTypeError`	If the long-running operation returned a response of the wrong type.

Response

If successful, the response contains an instance of Execution.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- cancel:
    call: googleapis.run.v1.namespaces.executions.cancel
    args:
        name: ...
    result: cancelResult

JSON

[
  {
    "cancel": {
      "call": "googleapis.run.v1.namespaces.executions.cancel",
      "args": {
        "name": "..."
      },
      "result": "cancelResult"
    }
  }
]