You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cli/activity.mdx
+25-42Lines changed: 25 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,8 +57,6 @@ Use the following options to change the behavior of this command. You can also u
57
57
|`--reason`| No |**string** Reason for cancellation. |
58
58
|`--run-id`, `-r`| No |**string** Activity Run ID. If not set, targets the latest run. |
59
59
60
-
To use the CLI with Standalone Activities, see the CLI commands in the [Go](/docs/develop/go/activities/standalone-activities.mdx) and [Python](/docs/develop/python/activities/standalone-activities.mdx) Standalone Activity guides.
61
-
62
60
## complete
63
61
64
62
Complete an Activity, marking it as successfully finished. Specify the
@@ -212,9 +210,7 @@ time it fails, completes, or times out, at which point the pause will kick in.
212
210
If the Activity is on its last retry attempt and fails, the failure will
213
211
be returned to the caller, just as if the Activity had not been paused.
214
212
215
-
Activities should be specified either by their Activity ID or Activity Type.
216
-
217
-
For example, specify the Activity and Workflow IDs like this:
213
+
Specify the Activity and Workflow IDs:
218
214
219
215
```
220
216
temporal activity pause \
@@ -229,9 +225,9 @@ Use the following options to change the behavior of this command. You can also u
229
225
230
226
| Flag | Required | Description |
231
227
|------|----------|-------------|
232
-
|`--activity-id`, `-a`| No |**string** The Activity ID to pause. Either `activity-id` or `activity-type` must be provided, but not both. |
233
-
|`--activity-type`| No |**string** All activities of the Activity Type will be paused. Either `activity-id` or `activity-type` must be provided, but not both. Note: Pausing Activity by Type is an experimental feature and may change in the future. |
228
+
|`--activity-id`, `-a`| No |**string** The Activity ID to pause. Required. |
234
229
|`--identity`| No |**string** The identity of the user or client submitting this request. |
230
+
|`--reason`| No |**string** Reason for pausing the Activity. |
Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands.
291
284
292
285
| Flag | Required | Description |
293
286
|------|----------|-------------|
294
-
|`--activity-id`, `-a`| No |**string** The Activity ID to reset. Mutually exclusive with `--query`, `--match-all`, and `--activity-type`. Requires `--workflow-id` to be specified. |
295
-
|`--activity-type`| No |**string** Activities of this Type will be reset. Mutually exclusive with `--match-all` and `activity-id`. Note: Resetting Activity by Type is an experimental feature and may change in the future. |
287
+
|`--activity-id`, `-a`| No |**string** The Activity ID to reset. Mutually exclusive with `--query`. Requires `--workflow-id` to be specified. |
296
288
|`--headers`| No |**string[]** Temporal workflow headers in 'KEY=VALUE' format. Keys must be identifiers, and values must be JSON values. May be passed multiple times to set multiple Temporal headers. Note: These are workflow headers, not gRPC headers. |
297
289
|`--jitter`| No |**duration** The activity will reset at random a time within the specified duration. Can only be used with --query. |
298
290
|`--keep-paused`| No |**bool** If the activity was paused, it will stay paused. |
299
-
|`--match-all`| No |**bool** Every activity should be reset. Every activity should be updated. Mutually exclusive with `--activity-id` and `--activity-type`. Note: This is an experimental feature and may change in the future. |
300
291
|`--query`, `-q`| No |**string** Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. Note: Using --query for batch activity operations is an experimental feature and may change in the future. |
301
292
|`--reason`| No |**string** Reason for batch operation. Only use with --query. Defaults to user name. |
302
293
|`--reset-attempts`| No |**bool** Reset the activity attempts. |
303
-
|`--reset-heartbeats`| No |**bool** Reset the Activity's heartbeats. Only works with --reset-attempts. |
294
+
|`--reset-heartbeats`| No |**bool** Reset the Activity's heartbeats. |
304
295
|`--restore-original-options`| No |**bool** Restore the original options of the activity. |
305
296
|`--rps`| No |**float** Limit batch's requests per second. Only allowed if query is present. |
306
297
|`--run-id`, `-r`| No |**string** Run ID. Only use with --workflow-id. Cannot use with --query. |
@@ -403,10 +394,9 @@ Activity to be retried another N times after unpausing.
403
394
404
395
Use `--reset-heartbeat` to reset the Activity's heartbeats.
405
396
406
-
Activities can be specified by their Activity ID or Activity Type.
407
-
One of those parameters must be provided.
397
+
Either `--activity-id` (with `--workflow-id`) or `--query` must be specified.
408
398
409
-
Specify the Activity ID or Type and Workflow IDs:
399
+
Specify the Activity and Workflow IDs:
410
400
411
401
```
412
402
temporal activity unpause \
@@ -416,28 +406,24 @@ temporal activity unpause \
416
406
--reset-heartbeats
417
407
```
418
408
419
-
Activities can be unpaused in bulk via a visibility Query list filter.
420
-
For example, if you want to unpause activities of type Foo that you
421
-
previously paused, do:
409
+
Activities can be unpaused in bulk via a visibility Query list filter:
Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands.
429
417
430
418
| Flag | Required | Description |
431
419
|------|----------|-------------|
432
-
|`--activity-id`, `-a`| No |**string** The Activity ID to unpause. Mutually exclusive with `--query`, `--match-all`, and `--activity-type`. Requires `--workflow-id` to be specified. |
433
-
|`--activity-type`| No |**string** Activities of this Type will unpause. Can only be used without --match-all. Either `activity-id` or `activity-type` must be provided, but not both. Note: Unpausing Activity by Type is an experimental feature and may change in the future. |
420
+
|`--activity-id`, `-a`| No |**string** The Activity ID to unpause. Mutually exclusive with `--query`. Requires `--workflow-id` to be specified. |
434
421
|`--headers`| No |**string[]** Temporal workflow headers in 'KEY=VALUE' format. Keys must be identifiers, and values must be JSON values. May be passed multiple times to set multiple Temporal headers. Note: These are workflow headers, not gRPC headers. |
435
422
|`--jitter`| No |**duration** The activity will start at random a time within the specified duration. Can only be used with --query. |
436
-
|`--match-all`| No |**bool** Every paused activity should be unpaused. This flag is ignored if activity-type is provided. Note: This is an experimental feature and may change in the future. |
437
423
|`--query`, `-q`| No |**string** Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. Note: Using --query for batch activity operations is an experimental feature and may change in the future. |
438
424
|`--reason`| No |**string** Reason for batch operation. Only use with --query. Defaults to user name. |
439
425
|`--reset-attempts`| No |**bool** Reset the activity attempts. |
440
-
|`--reset-heartbeats`| No |**bool** Reset the Activity's heartbeats. Only works with --reset-attempts. |
426
+
|`--reset-heartbeats`| No |**bool** Reset the Activity's heartbeats. |
441
427
|`--rps`| No |**float** Limit batch's requests per second. Only allowed if query is present. |
442
428
|`--run-id`, `-r`| No |**string** Run ID. Only use with --workflow-id. Cannot use with --query. |
443
429
|`--workflow-id`, `-w`| No |**string** Workflow ID. You must set either --workflow-id or --query. |
Use the following options to change the behavior of this command. You can also use any of the [global flags](#global-flags) that apply to all subcommands.
483
468
484
469
| Flag | Required | Description |
485
470
|------|----------|-------------|
486
-
|`--activity-id`, `-a`| No |**string** The Activity ID to update options. Mutually exclusive with `--query`, `--match-all`, and `--activity-type`. Requires `--workflow-id` to be specified. |
487
-
|`--activity-type`| No |**string** Activities of this Type will be updated. Mutually exclusive with `--match-all` and `activity-id`. Note: Updating Activity options by Type is an experimental feature and may change in the future. |
471
+
|`--activity-id`, `-a`| No |**string** The Activity ID to update options. Mutually exclusive with `--query`. Requires `--workflow-id` to be specified. |
488
472
|`--headers`| No |**string[]** Temporal workflow headers in 'KEY=VALUE' format. Keys must be identifiers, and values must be JSON values. May be passed multiple times to set multiple Temporal headers. Note: These are workflow headers, not gRPC headers. |
489
473
|`--heartbeat-timeout`| No |**duration** Maximum permitted time between successful worker heartbeats. |
490
-
|`--match-all`| No |**bool** Every activity should be updated. Mutually exclusive with `--activity-id` and `--activity-type`. Note: This is an experimental feature and may change in the future. |
491
474
|`--query`, `-q`| No |**string** Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. Note: Using --query for batch activity operations is an experimental feature and may change in the future. |
492
475
|`--reason`| No |**string** Reason for batch operation. Only use with --query. Defaults to user name. |
493
476
|`--restore-original-options`| No |**bool** Restore the original options of the activity. |
@@ -519,19 +502,19 @@ The following options can be used with any command.
519
502
|`--codec-header`| No |**string[]** HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. ||
|`--command-timeout`| No |**duration** The command execution timeout. 0s means no timeout. ||
522
-
|`--config-file`| No |**string** File path to read TOML config from, defaults to `$CONFIG_PATH/temporalio/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, `$HOME/Library/Application Support` on macOS, and `%AppData%` on Windows. _(Experimental)_||
523
-
|`--disable-config-env`| No |**bool** If set, disables loading environment config from environment variables. _(Experimental)_||
524
-
|`--disable-config-file`| No |**bool** If set, disables loading environment config from config file. _(Experimental)_||
505
+
|`--config-file`| No |**string** File path to read TOML config from, defaults to `$CONFIG_PATH/temporalio/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, `$HOME/Library/Application Support` on macOS, and `%AppData%` on Windows. ||
506
+
|`--disable-config-env`| No |**bool** If set, disables loading environment config from environment variables. ||
507
+
|`--disable-config-file`| No |**bool** If set, disables loading environment config from config file. ||
525
508
|`--env`| No |**string** Active environment name (`ENV`). |`default`|
526
509
|`--env-file`| No |**string** Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. ||
527
510
|`--grpc-meta`| No |**string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. ||
528
511
|`--identity`| No |**string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". ||
529
512
|`--log-format`| No |**string-enum** Log format. Accepted values: text, json. |`text`|
530
-
|`--log-level`| No |**string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. |`info`|
513
+
|`--log-level`| No |**string-enum** Log level. Default is "never" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. |`never`|
531
514
|`--namespace`, `-n`| No |**string** Temporal Service Namespace. |`default`|
532
515
|`--no-json-shorthand-payloads`| No |**bool** Raw payload output, even if the JSON option was used. ||
533
516
|`--output`, `-o`| No |**string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. |`text`|
534
-
|`--profile`| No |**string** Profile to use for config file. _(Experimental)_||
517
+
|`--profile`| No |**string** Profile to use for config file. ||
535
518
|`--time-format`| No |**string-enum** Time format. Accepted values: relative, iso, raw. |`relative`|
536
519
|`--tls`| No |**bool** Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. ||
537
520
|`--tls-ca-data`| No |**string** Data for server CA certificate. Can't be used with --tls-ca-path. ||
Copy file name to clipboardExpand all lines: docs/cli/batch.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,19 +88,19 @@ The following options can be used with any command.
88
88
|`--codec-header`| No |**string[]** HTTP headers for requests to codec server. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. ||
|`--command-timeout`| No |**duration** The command execution timeout. 0s means no timeout. ||
91
-
|`--config-file`| No |**string** File path to read TOML config from, defaults to `$CONFIG_PATH/temporalio/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, `$HOME/Library/Application Support` on macOS, and `%AppData%` on Windows. _(Experimental)_||
92
-
|`--disable-config-env`| No |**bool** If set, disables loading environment config from environment variables. _(Experimental)_||
93
-
|`--disable-config-file`| No |**bool** If set, disables loading environment config from config file. _(Experimental)_||
91
+
|`--config-file`| No |**string** File path to read TOML config from, defaults to `$CONFIG_PATH/temporalio/temporal.toml` where `$CONFIG_PATH` is defined as `$HOME/.config` on Unix, `$HOME/Library/Application Support` on macOS, and `%AppData%` on Windows. ||
92
+
|`--disable-config-env`| No |**bool** If set, disables loading environment config from environment variables. ||
93
+
|`--disable-config-file`| No |**bool** If set, disables loading environment config from config file. ||
94
94
|`--env`| No |**string** Active environment name (`ENV`). |`default`|
95
95
|`--env-file`| No |**string** Path to environment settings file. Defaults to `$HOME/.config/temporalio/temporal.yaml`. ||
96
96
|`--grpc-meta`| No |**string[]** HTTP headers for requests. Format as a `KEY=VALUE` pair. May be passed multiple times to set multiple headers. Can also be made available via environment variable as `TEMPORAL_GRPC_META_[name]`. ||
97
97
|`--identity`| No |**string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". ||
98
98
|`--log-format`| No |**string-enum** Log format. Accepted values: text, json. |`text`|
99
-
|`--log-level`| No |**string-enum** Log level. Default is "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. |`info`|
99
+
|`--log-level`| No |**string-enum** Log level. Default is "never" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. |`never`|
100
100
|`--namespace`, `-n`| No |**string** Temporal Service Namespace. |`default`|
101
101
|`--no-json-shorthand-payloads`| No |**bool** Raw payload output, even if the JSON option was used. ||
102
102
|`--output`, `-o`| No |**string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. |`text`|
103
-
|`--profile`| No |**string** Profile to use for config file. _(Experimental)_||
103
+
|`--profile`| No |**string** Profile to use for config file. ||
104
104
|`--time-format`| No |**string-enum** Time format. Accepted values: relative, iso, raw. |`relative`|
105
105
|`--tls`| No |**bool** Enable base TLS encryption. Does not have additional options like mTLS or client certs. This is defaulted to true if api-key or any other TLS options are present. Use --tls=false to explicitly disable. ||
106
106
|`--tls-ca-data`| No |**string** Data for server CA certificate. Can't be used with --tls-ca-path. ||
0 commit comments