@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias ActivatedJobResult

    type ActivatedJobResult = {
        customHeaders: { [key: string]: unknown };
        deadline: number;
        elementId: ElementId;
        elementInstanceKey: ElementInstanceKey;
        jobKey: JobKey;
        kind: JobKindEnum;
        listenerEventType: JobListenerEventTypeEnum;
        processDefinitionId: ProcessDefinitionId;
        processDefinitionKey: ProcessDefinitionKey;
        processDefinitionVersion: number;
        processInstanceKey: ProcessInstanceKey;
        retries: number;
        tags?: TagSet;
        tenantId: TenantId;
        type: string;
        userTask?: UserTaskProperties;
        variables: { [key: string]: unknown };
        worker: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    customHeaders deadline elementId elementInstanceKey jobKey kind listenerEventType processDefinitionId processDefinitionKey processDefinitionVersion processInstanceKey retries tags? tenantId type userTask? variables worker

    Properties

    customHeaders: { [key: string]: unknown }

    A set of custom headers defined during modelling; returned as a serialized JSON document.

    deadline: number

    When the job can be activated again, sent as a UNIX epoch timestamp.

    elementId: ElementId

    The associated task element ID.

    elementInstanceKey: ElementInstanceKey

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

    jobKey: JobKey

    The key, a unique identifier for the job.

    kind: JobKindEnum
    listenerEventType: JobListenerEventTypeEnum
    processDefinitionId: ProcessDefinitionId

    The bpmn process ID of the job's process definition.

    processDefinitionKey: ProcessDefinitionKey

    The key of the job's process definition.

    processDefinitionVersion: number

    The version of the job's process definition.

    processInstanceKey: ProcessInstanceKey

    The job's process instance key.

    retries: number

    The amount of retries left to this job (should always be positive).

    tags?: TagSet
    tenantId: TenantId

    The ID of the tenant that owns the job.

    type: string

    The type of the job (should match what was requested).

    userTask?: UserTaskProperties
    variables: { [key: string]: unknown }

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

    worker: string

    The name of the worker which activated this job.

    Settings

    Member Visibility

    On This Page

    Properties