- NAME
-
- gcloud workflows executions cancel - cancel a workflow execution
- SYNOPSIS
-
-
gcloud workflows executions cancel
(EXECUTION
:--location
=LOCATION
--workflow
=WORKFLOW
) [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
- Cancel a workflow execution.
- EXAMPLES
-
To cancel an execution with ID 'my-workflow-execution-ID' from a workflow named
'my-workflow', run:
gcloud workflows executions cancel my-workflow-execution-ID --workflow=my-workflow
- POSITIONAL ARGUMENTS
-
-
Execution resource - The name of the workflow execution to cancel. The arguments
in this group can be used to specify the attributes of this resource. (NOTE)
Some attributes are not given arguments in this group but can be set in other
ways.
To set the
project
attribute:-
provide the argument
execution
on the command line with a fully specified name; -
provide the argument
--project
on the command line; -
set the property
core/project
.
This must be specified.
EXECUTION
-
ID of the execution or fully qualified identifier for the execution.
To set the
execution
attribute:-
provide the argument
execution
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location
=LOCATION
-
The Cloud location for the execution. Alternatively, set the property
[workflows/location].
To set the
location
attribute:-
provide the argument
execution
on the command line with a fully specified name; -
provide the argument
--location
on the command line; -
set the property
workflows/location
.
-
provide the argument
--workflow
=WORKFLOW
-
The Cloud Workflow for the execution.
To set the
workflow
attribute:-
provide the argument
execution
on the command line with a fully specified name; -
provide the argument
--workflow
on the command line.
-
provide the argument
-
provide the argument
-
Execution resource - The name of the workflow execution to cancel. The arguments
in this group can be used to specify the attributes of this resource. (NOTE)
Some attributes are not given arguments in this group but can be set in other
ways.
- GCLOUD WIDE FLAGS
-
These flags are available to all commands:
--access-token-file
,--account
,--billing-project
,--configuration
,--flags-file
,--flatten
,--format
,--help
,--impersonate-service-account
,--log-http
,--project
,--quiet
,--trace-token
,--user-output-enabled
,--verbosity
.Run
$ gcloud help
for details. - API REFERENCE
-
This command uses the
workflowexecutions/v1
API. The full documentation for this API can be found at: https://cloud.google.com/workflows - NOTES
-
This variant is also available:
gcloud beta workflows executions cancel
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-06 UTC.