Stop Job

Stops a job of the job's workspace.

Behaviour

Risk: High · Idempotent: No · Safe to retry: No · Recovery: Not replayed after a crash

Package Orchestrator activities VeloPhex.Orchestrator.Activities 0.7.1-rc.12 · Supported (Core profile) · type id velophex.orchestrator.stopJob

Properties#

Input#

Job Id#

JobId · String · Optional · Default: Not specified in package metadata

The job to stop, as Start Job returned it. Empty uses Job.

Job#

Job · Job · Optional · Default: Not specified in package metadata

The job to stop, as Get Jobs returned it. Used when Job Id is empty.

Strategy#

Strategy · String · Optional · Default: Not specified in package metadata

Soft Stop asks the job to stop; Kill ends it at once. Empty is Soft Stop.

Allowed values: SoftStop, Kill.

Retry and risk#

This activity is not marked safe to retry: if it fails partway, check whether its work already happened before running it again. If a run is interrupted and the outcome of a step is unknown, the step is never retried automatically (what to do). How activities declare this: characteristics, retries and risk.

Every activity also has the engine's common properties: Timeout and Continue On Error.

Generated from VeloPhex.Orchestrator.Activities 0.7.1-rc.12. Category: Jobs. Keywords: job, stop, cancel, kill, terminate, orchestrator.

Properties

Input

Retry and risk

Related activities