diff --git a/temporalcli/commands.gen.go b/temporalcli/commands.gen.go index fc5c93a4..347ce01d 100644 --- a/temporalcli/commands.gen.go +++ b/temporalcli/commands.gen.go @@ -388,9 +388,9 @@ func NewTemporalWorkflowCancelCommand(cctx *CommandContext, parent *TemporalWork s.Command.Use = "cancel [flags]" s.Command.Short = "Cancel a Workflow Execution." if hasHighlighting { - s.Command.Long = "The \x1b[1mtemporal workflow cancel\x1b[0m command is used to cancel a Workflow Execution. Canceling a running Workflow Execution records a \x1b[1mWorkflowExecutionCancelRequested\x1b[0m event in the Event History. A new Command Task will be scheduled, and the Workflow Execution will perform cleanup work.\n\nExecutions may be cancelled by ID:\n\x1b[1mtemporal workflow cancel --workflow-id MyWorkflowId\x1b[0m\n\n...or in bulk via a visibility query list filter:\n\n\x1b[1mtemporal workflow cancel --query=MyQuery\x1b[0m\n\nUse the options listed below to change the behavior of this command." + s.Command.Long = "The \x1b[1mtemporal workflow cancel\x1b[0m command is used to cancel a Workflow Execution. Canceling a running Workflow Execution records a \x1b[1mWorkflowExecutionCancelRequested\x1b[0m event in the Event History. A new Command Task will be scheduled, and the Workflow Execution will perform cleanup work.\n\nExecutions may be cancelled by ID:\n\x1b[1mtemporal workflow cancel --workflow-id MyWorkflowId\x1b[0m\n\n...or in bulk via a visibility query list filter:\n\x1b[1mtemporal workflow cancel --query=MyQuery\x1b[0m\n\nUse the options listed below to change the behavior of this command." } else { - s.Command.Long = "The `temporal workflow cancel` command is used to cancel a Workflow Execution. Canceling a running Workflow Execution records a `WorkflowExecutionCancelRequested` event in the Event History. A new Command Task will be scheduled, and the Workflow Execution will perform cleanup work.\n\nExecutions may be cancelled by ID:\n```\ntemporal workflow cancel --workflow-id MyWorkflowId\n```\n\n...or in bulk via a visibility query list filter:\n\n```\ntemporal workflow cancel --query=MyQuery\n```\n\nUse the options listed below to change the behavior of this command." + s.Command.Long = "The `temporal workflow cancel` command is used to cancel a Workflow Execution. Canceling a running Workflow Execution records a `WorkflowExecutionCancelRequested` event in the Event History. A new Command Task will be scheduled, and the Workflow Execution will perform cleanup work.\n\nExecutions may be cancelled by ID:\n```\ntemporal workflow cancel --workflow-id MyWorkflowId\n```\n\n...or in bulk via a visibility query list filter:\n```\ntemporal workflow cancel --query=MyQuery\n```\n\nUse the options listed below to change the behavior of this command." } s.Command.Args = cobra.NoArgs s.SingleWorkflowOrBatchOptions.buildFlags(cctx, s.Command.Flags()) @@ -653,7 +653,7 @@ type SingleWorkflowOrBatchOptions struct { func (v *SingleWorkflowOrBatchOptions) buildFlags(cctx *CommandContext, f *pflag.FlagSet) { f.StringVarP(&v.WorkflowId, "workflow-id", "w", "", "Workflow Id. Either this or query must be set.") f.StringVarP(&v.RunId, "run-id", "r", "", "Run Id. Cannot be set when query is set.") - f.StringVarP(&v.Query, "query", "q", "", "Start a batch to Signal Workflow Executions with given List Filter. Either this or Workflow Id must be set.") + f.StringVarP(&v.Query, "query", "q", "", "Start a batch to operate on Workflow Executions with given List Filter. Either this or Workflow Id must be set.") f.StringVar(&v.Reason, "reason", "", "Reason to perform batch. Only allowed if query is present unless the command specifies otherwise. Defaults to message with the current user's name.") f.BoolVarP(&v.Yes, "yes", "y", false, "Confirm prompt to perform batch. Only allowed if query is present.") } diff --git a/temporalcli/commandsmd/commands.md b/temporalcli/commandsmd/commands.md index 3211adec..7367b86c 100644 --- a/temporalcli/commandsmd/commands.md +++ b/temporalcli/commandsmd/commands.md @@ -217,7 +217,6 @@ temporal workflow cancel --workflow-id MyWorkflowId ``` ...or in bulk via a visibility query [list filter](/concepts/what-is-a-list-filter): - ``` temporal workflow cancel --query=MyQuery ``` @@ -355,7 +354,7 @@ Includes options set for [payload input](#options-set-for-payload-input). * `--workflow-id`, `-w` (string) - Workflow Id. Either this or query must be set. * `--run-id`, `-r` (string) - Run Id. Cannot be set when query is set. -* `--query`, `-q` (string) - Start a batch to Signal Workflow Executions with given List Filter. Either this or +* `--query`, `-q` (string) - Start a batch to operate on Workflow Executions with given List Filter. Either this or Workflow Id must be set. * `--reason` (string) - Reason to perform batch. Only allowed if query is present unless the command specifies otherwise. Defaults to message with the current user's name. * `--yes`, `-y` (bool) - Confirm prompt to perform batch. Only allowed if query is present.