Skip to content

Commit 7f12fd1

Browse files
JLDLaughlinclaude
andauthored
Remove --activity-type and --match-all references from activity operations docs (#4419)
Removes by-type targeting references from all activity operator commands (pause, reset, update-options). Matches CLI PR temporalio/cli#978 which removed these flags from pause/unpause/reset/update-options. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 84df250 commit 7f12fd1

1 file changed

Lines changed: 3 additions & 7 deletions

File tree

docs/encyclopedia/activities/activity-operations.mdx

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ temporal activity pause \
7777
--reason "Downstream API is down, pausing until recovery"
7878
```
7979

80-
See the [CLI reference for `temporal activity pause`](/cli/activity#pause) for all options, including `--activity-type` for targeting by type.
80+
See the [CLI reference for `temporal activity pause`](/cli/activity#pause) for all options.
8181

8282
### Detect Pause in Activity code
8383

@@ -104,11 +104,9 @@ Your Activity code may need to handle these cases differently, for example relea
104104

105105
- **A Paused Activity can still time out.** Pause doesn't stop or extend the [Schedule-To-Close Timeout](/encyclopedia/detecting-activity-failures#schedule-to-close-timeout). Use [`update-options`](#update-options) to adjust the timeout if needed.
106106
- **Pause won't interrupt an Activity that doesn't Heartbeat.** The current execution runs to completion, which could take up to the full [Start-To-Close Timeout](/encyclopedia/detecting-activity-failures#start-to-close-timeout).
107-
- **Pausing by `--activity-type` doesn't prevent new Activities of that type from running.** The command Pauses Activities that are pending when it runs. Activities that start afterward are unaffected.
108-
109107
### Limitations
110108

111-
- **Pause doesn't support bulk operations.** Unlike Unpause, Reset, and Update Options, there's no `--query` flag. You can only Pause Activities within a single Workflow, by Activity Id or by Activity type.
109+
- **Pause operates on individual Activities by ID within a single Workflow.** Unlike Unpause, Reset, and Update Options, there's no `--query` flag. To pause multiple Activities, issue separate commands for each Activity ID.
112110
- **No Namespace-wide query for Paused Activities.** You must know the Workflow Id. See [Observability](#observability).
113111

114112
## Unpause {#unpause}
@@ -206,7 +204,6 @@ Your Activity code may need to handle these cases differently, for example savin
206204
- **Heartbeat details are preserved by default.** If your Activity uses Heartbeat details for progress tracking and you want a clean restart, pass `--reset-heartbeats`.
207205
- **Reset won't interrupt an Activity that doesn't Heartbeat.** The current execution runs to completion, which could take up to the full [Start-To-Close Timeout](/encyclopedia/detecting-activity-failures#start-to-close-timeout). If the Activity had already retried (attempt > 1), the Temporal Service rejects the current execution's result because Reset changed the expected attempt number. The Activity waits for its Start-To-Close Timeout to expire before a new execution is scheduled.
208206
- **`--restore-original-options` restores the Activity's original configuration.** It reverts timeouts, Retry Policy, and Task Queue to the values from when the Activity was first scheduled.
209-
- **Resetting by `--activity-type` or `--match-all` doesn't affect new Activities of that type.** The command Resets Activities that are pending when it runs. Activities that start afterward are unaffected.
210207
- **Bulk Reset can overwhelm downstream services.** When using `--query` to Reset Activities across many Workflows, use `--jitter` to stagger the restart times.
211208

212209
## Update Options {#update-options}
@@ -247,7 +244,6 @@ See the [CLI reference for `temporal activity update-options`](/cli/activity#upd
247244
### Important considerations
248245

249246
- **Changes to a running Activity take effect on the next execution, not the current one.** If you need the change to apply immediately, the Activity must finish or fail its current execution first.
250-
- **Updating by `--activity-type` or `--match-all` doesn't affect new Activities of that type.** The command updates Activities that are pending when it runs. Activities that start afterward are unaffected.
251247
- **`--restore-original-options` is batch-only.** This flag only works with `--query`. It's silently ignored in single-workflow mode. It can't be combined with other option changes in the same command.
252248

253249
### Limitations
@@ -265,7 +261,7 @@ The UI shows who performed an operation, when, and why (if a `--reason` was prov
265261

266262
### Find Paused Activities
267263

268-
The `TemporalPauseInfo` [Search Attribute](/search-attribute) is filterable by Activity type within a Workflow.
264+
The `TemporalPauseInfo` [Search Attribute](/search-attribute) is filterable within a Workflow.
269265

270266
There's no Namespace-wide query to find all Paused Activities across Workflows.
271267
You must know the Workflow Id.

0 commit comments

Comments
 (0)