hpcflow.sdk.monitoring.status.cancel#

hpcflow.sdk.monitoring.status.cancel(app, workflow_ref, ref_type=None, quiet=False)#

Cancel saved jobs for all retained parts matching a workflow reference.

Use registry references even if workflow data cannot be loaded. Legacy records may first require hydration. Batch requests by scheduler context and deduplicate references within each context. Persist cancellation requests as unknown activity pending a subsequent observation. Comma-separated IDs select multiple workflows; reject unknown IDs before issuing any cancellation requests. Overlapping workflow selections are deduplicated.

Return False only when no registry record matches, allowing a caller fallback. Return True for handled records, including those with no active jobs. If some requests fail, complete the remaining contexts and then raise RuntimeError with the collected errors.

Parameters:

app (BaseApp)

Return type:

bool