Skip to main content

Interface: ExecuteJobOutcome

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:116

Properties​

attempt?​

optional attempt?: number

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:138

The job attempt that ran (1 on the first execution).

dead?​

optional dead?: boolean

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:125

The job referred to a run, workflow or stage that no longer exists (an orphan queue row), or the message itself was malformed. It was failed terminally and acknowledged; nothing was executed and no run was transitioned.

deferred?​

optional deferred?: boolean

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:153

The job was returned to the queue without counting an attempt, because this host declined it rather than failing it — today only for a run pinned to a definition version this build does not present. A push-transport consumer should redeliver the message after retryDelayMs and must not count it against its own retry budget.

error?​

optional error?: string

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:118

maxAttempts?​

optional maxAttempts?: number

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:140

The attempt budget the retry decision used.

outcome​

outcome: "failed" | "completed" | "suspended"

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:117

retryDelayMs?​

optional retryDelayMs?: number

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:145

Backoff before the retry, when willRetry is true: the exponential delay the built-in transports apply (2^attempt seconds).

willRetry?​

optional willRetry?: boolean

Defined in: packages/workflow-engine/src/kernel/helpers/host-support.ts:136

The job must run again — either the stage failed with attempts left and was left PENDING, or the job was dequeued ahead of the claim that enqueued it (a still-PENDING run; see ghostReason: "race" on JobExecuteResult). The built-in transports re-enqueue it themselves from fail(jobId, error, true); a push transport whose fail() cannot re-enqueue (a queue consumer that has to retry() the message) must retry the message after retryDelayMs, and acknowledge it when this is false.