Skip to main content

Interface: EnqueueJobInput

Defined in: packages/workflow-engine/src/persistence/interface.ts:527

Properties​

definitionVersion?​

optional definitionVersion?: string | null

Defined in: packages/workflow-engine/src/persistence/interface.ts:548

The definition version of the run this job belongs to (null for a run created before the consumer migrated); stored on the payload as _definitionVersion so a dequeue can decline a job whose run this build cannot serve, without joining to workflow_runs.


groupKey?​

optional groupKey?: string

Defined in: packages/workflow-engine/src/persistence/interface.ts:541

Fairness group this job belongs to — typically a tenant id. Stored on the payload as _groupKey; a transport with fairness enabled presents only the head of each group as a dequeue candidate, so one group cannot starve another. Ignored when the transport has no fairness configured, which is the default.


payload?​

optional payload?: Record<string, unknown>

Defined in: packages/workflow-engine/src/persistence/interface.ts:532


priority?​

optional priority?: number

Defined in: packages/workflow-engine/src/persistence/interface.ts:531


scheduledFor?​

optional scheduledFor?: Date

Defined in: packages/workflow-engine/src/persistence/interface.ts:533


stageId​

stageId: string

Defined in: packages/workflow-engine/src/persistence/interface.ts:530


workflowId​

workflowId: string

Defined in: packages/workflow-engine/src/persistence/interface.ts:529


workflowRunId​

workflowRunId: string

Defined in: packages/workflow-engine/src/persistence/interface.ts:528