Interface Job<Variables, CustomHeaderShape>

Type Parameters

Hierarchy

Properties

bpmnProcessId customHeaders deadline elementId elementInstanceKey key processDefinitionVersion processInstanceKey processKey retries type variables worker

Properties

Readonly bpmnProcessId

bpmnProcessId: string

The bpmn process ID of the job process definition

Readonly customHeaders

customHeaders: Readonly<CustomHeaderShape>

A set of custom headers defined during modelling

Readonly deadline

deadline: string

Readonly elementId

elementId: string

The associated task element ID

Readonly elementInstanceKey

elementInstanceKey: string

The unique key identifying the associated task, unique within the scope of the process instance

Readonly key

key: string

The key, a unique identifier for the job

Readonly processDefinitionVersion

processDefinitionVersion: number

The version of the job process definition

Readonly processInstanceKey

processInstanceKey: string

The job's process instance key

Readonly processKey

processKey: string

The key of the job process definition

Readonly retries

retries: number

Readonly type

type: string

The job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type="payment-service" />)

Readonly variables

variables: Readonly<Variables>

All visible variables in the task scope, computed at activation time.

Readonly worker

worker: string

The name of the worker that activated this job

Settings

Member Visibility

Theme

Generated using TypeDoc