@camunda8/sdk
    Preparing search index...

    Interface Job<Variables, CustomHeaderShape>

    interface Job<Variables = IInputVariables, CustomHeaderShape = ICustomHeaders> {
        bpmnProcessId: string;
        customHeaders: Readonly<CustomHeaderShape>;
        deadline: string;
        elementId: string;
        elementInstanceKey: string;
        key: string;
        processDefinitionVersion: number;
        processInstanceKey: string;
        retries: number;
        tenantId: string;
        type: string;
        variables: Readonly<Variables>;
        worker: string;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    bpmnProcessId: string

    The bpmn process ID of the job process definition

    customHeaders: Readonly<CustomHeaderShape>

    A set of custom headers defined during modelling

    deadline: string

    Epoch milliseconds

    elementId: string

    The associated task element ID

    elementInstanceKey: string

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

    key: string

    The key, a unique identifier for the job

    processDefinitionVersion: number

    The version of the job process definition

    processInstanceKey: string

    The job's process instance key

    retries: number
    tenantId: string

    The tenantId of the job in a multi-tenant cluster

    type: string

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

    variables: Readonly<Variables>

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

    worker: string

    The name of the worker that activated this job

    Settings

    Member Visibility

    On This Page

    Properties