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
+12-14Lines changed: 12 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,8 +27,6 @@ This file is generated from https://github.com/temporalio/cli/blob/main/internal
27
27
28
28
This page provides a reference for the `temporal` CLI `activity` command. The flags applicable to each subcommand are presented in a table within the heading for the subcommand. Refer to [Global Flags](#global-flags) for flags that you can use with every subcommand.
29
29
30
-
To use the CLI with Standalone Activities, see the CLI commands in the [Go](/docs/develop/go/standalone-activities.mdx), [Python](/docs/develop/python/standalone-activities.mdx), and [.NET](/docs/develop/dotnet/standalone-activities.mdx) Standalone Activity guides.
31
-
32
30
## complete
33
31
34
32
Complete an Activity, marking it as successfully finished. Specify the
@@ -116,7 +114,7 @@ activity timeout, as well as, optionally, the
116
114
117
115
If the activity may be executing (i.e. it has not yet timed out), the
118
116
reset will take effect the next time it fails, heartbeats, or times out.
119
-
If it is waiting for a retry (i.e. has failed or timed out), the reset
117
+
If is waiting for a retry (i.e. has failed or timed out), the reset
120
118
will apply immediately.
121
119
122
120
If the activity is already paused, it will be unpaused by default.
@@ -138,7 +136,7 @@ reset, handle this error and then re-throw it when you've cleaned up.
138
136
139
137
If the `reset_heartbeats` flag is set, the heartbeat details will also be cleared.
140
138
141
-
Specify the Activity Type or ID and Workflow IDs:
139
+
Specify the Activity Type of ID and Workflow IDs:
142
140
143
141
```
144
142
temporal activity reset \
@@ -163,12 +161,12 @@ Use the following options to change the behavior of this command. You can also u
163
161
| Flag | Required | Description |
164
162
|------|----------|-------------|
165
163
|`--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. |
166
-
|`--activity-type`| No |**string** Activities of this Type will be reset. Mutually exclusive with `--match-all` and `activity-id`. |
164
+
|`--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. |
167
165
|`--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. |
168
166
|`--jitter`| No |**duration** The activity will reset at random a time within the specified duration. Can only be used with --query. |
169
167
|`--keep-paused`| No |**bool** If the activity was paused, it will stay paused. |
170
-
|`--match-all`| No |**bool** Every activity should be reset. Every activity should be updated. Mutually exclusive with `--activity-id` and `--activity-type`. |
171
-
|`--query`, `-q`| No |**string** Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. |
168
+
|`--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. |
169
+
|`--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. |
172
170
|`--reason`| No |**string** Reason for batch operation. Only use with --query. Defaults to user name. |
173
171
|`--reset-attempts`| No |**bool** Reset the activity attempts. |
174
172
|`--reset-heartbeats`| No |**bool** Reset the Activity's heartbeats. Only works with --reset-attempts. |
@@ -220,11 +218,11 @@ Use the following options to change the behavior of this command. You can also u
220
218
| Flag | Required | Description |
221
219
|------|----------|-------------|
222
220
|`--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. |
223
-
|`--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. |
221
+
|`--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. |
224
222
|`--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. |
225
223
|`--jitter`| No |**duration** The activity will start at random a time within the specified duration. Can only be used with --query. |
226
-
|`--match-all`| No |**bool** Every paused activity should be unpaused. This flag is ignored if activity-type is provided. |
227
-
|`--query`, `-q`| No |**string** Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. |
224
+
|`--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. |
225
+
|`--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. |
228
226
|`--reason`| No |**string** Reason for batch operation. Only use with --query. Defaults to user name. |
229
227
|`--reset-attempts`| No |**bool** Reset the activity attempts. |
230
228
|`--reset-heartbeats`| No |**bool** Reset the Activity's heartbeats. Only works with --reset-attempts. |
@@ -273,11 +271,11 @@ Use the following options to change the behavior of this command. You can also u
273
271
| Flag | Required | Description |
274
272
|------|----------|-------------|
275
273
|`--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. |
276
-
|`--activity-type`| No |**string** Activities of this Type will be updated. Mutually exclusive with `--match-all` and `activity-id`. |
274
+
|`--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. |
277
275
|`--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. |
278
276
|`--heartbeat-timeout`| No |**duration** Maximum permitted time between successful worker heartbeats. |
279
-
|`--match-all`| No |**bool** Every activity should be updated. Mutually exclusive with `--activity-id` and `--activity-type`. |
280
-
|`--query`, `-q`| No |**string** Content for an SQL-like `QUERY` List Filter. You must set either --workflow-id or --query. |
277
+
|`--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. |
278
+
|`--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. |
281
279
|`--reason`| No |**string** Reason for batch operation. Only use with --query. Defaults to user name. |
282
280
|`--restore-original-options`| No |**bool** Restore the original options of the activity. |
283
281
|`--retry-backoff-coefficient`| No |**float** Coefficient used to calculate the next retry interval. The next retry interval is previous interval multiplied by the backoff coefficient. Must be 1 or larger. |
@@ -316,7 +314,7 @@ The following options can be used with any command.
316
314
|`--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]`. ||
317
315
|`--identity`| No |**string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". ||
318
316
|`--log-format`| No |**string-enum** Log format. Accepted values: text, json. |`text`|
319
-
|`--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`|
317
+
|`--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`|
320
318
|`--namespace`, `-n`| No |**string** Temporal Service Namespace. |`default`|
321
319
|`--no-json-shorthand-payloads`| No |**bool** Raw payload output, even if the JSON option was used. ||
322
320
|`--output`, `-o`| No |**string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. |`text`|
Copy file name to clipboardExpand all lines: docs/cli/batch.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -96,7 +96,7 @@ The following options can be used with any command.
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 "info" for most commands and "warn" for "server start-dev". Accepted values: debug, info, warn, error, never. |`info`|
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`|
Copy file name to clipboardExpand all lines: docs/cli/config.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -121,7 +121,7 @@ The following options can be used with any command.
121
121
|`--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]`. ||
122
122
|`--identity`| No |**string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". ||
123
123
|`--log-format`| No |**string-enum** Log format. Accepted values: text, json. |`text`|
124
-
|`--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`|
124
+
|`--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`|
125
125
|`--namespace`, `-n`| No |**string** Temporal Service Namespace. |`default`|
126
126
|`--no-json-shorthand-payloads`| No |**bool** Raw payload output, even if the JSON option was used. ||
127
127
|`--output`, `-o`| No |**string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. |`text`|
Copy file name to clipboardExpand all lines: docs/cli/env.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -132,7 +132,7 @@ The following options can be used with any command.
132
132
|`--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]`. ||
133
133
|`--identity`| No |**string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". ||
134
134
|`--log-format`| No |**string-enum** Log format. Accepted values: text, json. |`text`|
135
-
|`--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`|
135
+
|`--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`|
136
136
|`--namespace`, `-n`| No |**string** Temporal Service Namespace. |`default`|
137
137
|`--no-json-shorthand-payloads`| No |**bool** Raw payload output, even if the JSON option was used. ||
138
138
|`--output`, `-o`| No |**string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. |`text`|
Copy file name to clipboardExpand all lines: docs/cli/operator.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -540,7 +540,7 @@ The following options can be used with any command.
540
540
|`--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]`. ||
541
541
|`--identity`| No |**string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". ||
542
542
|`--log-format`| No |**string-enum** Log format. Accepted values: text, json. |`text`|
543
-
|`--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`|
543
+
|`--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`|
544
544
|`--namespace`, `-n`| No |**string** Temporal Service Namespace. |`default`|
545
545
|`--no-json-shorthand-payloads`| No |**bool** Raw payload output, even if the JSON option was used. ||
546
546
|`--output`, `-o`| No |**string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. |`text`|
Copy file name to clipboardExpand all lines: docs/cli/schedule.mdx
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -254,6 +254,16 @@ temporal schedule update \
254
254
--workflow-type "NewWorkflowType"
255
255
```
256
256
257
+
This command performs a full replacement of the Schedule
258
+
configuration. Any options not provided will be reset to their default
259
+
values. You must re-specify all options, not just the ones you want to
260
+
change. To view the current configuration of a Schedule, use
261
+
`temporal schedule describe` before updating.
262
+
263
+
Schedule memo and search attributes cannot be updated with this
264
+
command. They are set only during Schedule creation and are not affected
265
+
by updates.
266
+
257
267
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.
258
268
259
269
| Flag | Required | Description |
@@ -281,8 +291,6 @@ Use the following options to change the behavior of this command. You can also u
281
291
|`--remaining-actions`| No |**int** Total allowed actions. Default is zero (unlimited). |
282
292
|`--run-timeout`| No |**duration** Fail a Workflow Run if it lasts longer than `DURATION`. |
|`--schedule-memo`| No |**string[]** Set schedule memo using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. |
285
-
|`--schedule-search-attribute`| No |**string[]** Set schedule Search Attributes using `KEY="VALUE` pairs. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. |
286
294
|`--search-attribute`| No |**string[]** Search Attribute in `KEY=VALUE` format. Keys must be identifiers, and values must be JSON values. For example: `'YourKey={"your": "value"}'`. Can be passed multiple times. |
287
295
|`--start-time`| No |**timestamp** Schedule start time. |
288
296
|`--static-details`| No |**string** Static Workflow details for human consumption in UIs. Uses Temporal Markdown formatting, may be multiple lines. _(Experimental)_|
@@ -316,7 +324,7 @@ The following options can be used with any command.
316
324
|`--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]`. ||
317
325
|`--identity`| No |**string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". ||
318
326
|`--log-format`| No |**string-enum** Log format. Accepted values: text, json. |`text`|
319
-
|`--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`|
327
+
|`--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`|
320
328
|`--namespace`, `-n`| No |**string** Temporal Service Namespace. |`default`|
321
329
|`--no-json-shorthand-payloads`| No |**bool** Raw payload output, even if the JSON option was used. ||
322
330
|`--output`, `-o`| No |**string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. |`text`|
Copy file name to clipboardExpand all lines: docs/cli/server.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -106,7 +106,7 @@ The following options can be used with any command.
106
106
|`--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]`. ||
107
107
|`--identity`| No |**string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". ||
108
108
|`--log-format`| No |**string-enum** Log format. Accepted values: text, json. |`text`|
109
-
|`--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`|
109
+
|`--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`|
110
110
|`--namespace`, `-n`| No |**string** Temporal Service Namespace. |`default`|
111
111
|`--no-json-shorthand-payloads`| No |**bool** Raw payload output, even if the JSON option was used. ||
112
112
|`--output`, `-o`| No |**string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. |`text`|
Copy file name to clipboardExpand all lines: docs/cli/task-queue.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -693,7 +693,7 @@ The following options can be used with any command.
693
693
|`--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]`. ||
694
694
|`--identity`| No |**string** The identity of the user or client submitting this request. Defaults to "temporal-cli:$USER@$HOST". ||
695
695
|`--log-format`| No |**string-enum** Log format. Accepted values: text, json. |`text`|
696
-
|`--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`|
696
+
|`--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`|
697
697
|`--namespace`, `-n`| No |**string** Temporal Service Namespace. |`default`|
698
698
|`--no-json-shorthand-payloads`| No |**bool** Raw payload output, even if the JSON option was used. ||
699
699
|`--output`, `-o`| No |**string-enum** Non-logging data output format. Accepted values: text, json, jsonl, none. |`text`|
0 commit comments