Skip to main content

Module pause

Module pause 

Source
Expand description

Operator pause of a run, or of a whole workflow.

Engine::pause_run holds a root run, with every sub-workflow run below it, in Paused until Engine::resume_paused_run puts each one back in the state it was paused from, or Engine::cancel_run stops it. A run executing when it is paused has its step in flight interrupted with STEP_INTERRUPTED_ERROR, no further step is started, and the resume replays the run: finished steps are skipped and the interrupted step is executed again.

Engine::pause_workflow holds the queued runs of a workflow instead: they are created as usual but no worker picks them up until Engine::resume_workflow. Under ExecutionMode::Local no worker exists: a run created while the workflow is paused stays Pending, and Engine::resume_workflow starts it in a background task.

Structsยง

RunPause
Outcome of Engine::pause_run.
RunResume
Outcome of Engine::resume_paused_run.