WorkflowCancelledError
junjo.WorkflowCancelledError
Kind: Exception Class
SDK version: 0.64.0
Documentation channel: Next source preview
Signature
Section titled “Signature”WorkflowCancelledError(*cancel_args: object, run_id: str, definition_id: str, name: str, state: StateT, node_execution_counts: Mapping[str, int], state_is_terminal: bool = True, terminalization_error: BaseException | None = None)Caller-visible Workflow cancellation with admitted execution identity.
This remains an CancelledError, so normal task
cancellation handling continues to work. Its args preserve the
original cancellation reason and the original cancellation is retained as
__cause__. The additional fields identify the admitted execution and
expose its detached terminal state.
Parameters
Section titled “Parameters”| Name | Type | Description | Default |
|---|---|---|---|
run_id |
str |
Unique runtime identity of the admitted execution. | |
definition_id |
str |
Stable in-process Workflow definition identity. | |
name |
str |
Configured Workflow or Subflow name. | |
state |
StateT |
Detached final state snapshot collected during terminalization. | |
state_is_terminal |
bool |
Whether terminal Store evidence collection completed. When False, state is the last detached snapshotavailable during emergency recovery. |
True |
terminalization_error |
BaseException | None |
A separate failure encountered while collecting terminal Store evidence, if any. The original cancellation remains __cause__. |
None |
node_execution_counts |
Mapping[str, int] |
Current-scope execution counts observed before cancellation. |