Interface ZeebeJob<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables>

interface ZeebeJob<WorkerInputVariables, CustomHeaderShape, WorkerOutputVariables> {
    bpmnProcessId: string;
    cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">);
    complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">);
    customHeaders: Readonly<CustomHeaderShape>;
    deadline: string;
    elementId: string;
    elementInstanceKey: string;
    error: ErrorJobOutcome;
    fail: {
        (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
        (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
    };
    forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT");
    key: string;
    processDefinitionVersion: number;
    processInstanceKey: string;
    retries: number;
    tenantId: string;
    type: string;
    variables: Readonly<WorkerInputVariables>;
    worker: string;
}

Type Parameters

Hierarchy (view full)

Properties

bpmnProcessId cancelWorkflow complete customHeaders deadline elementId elementInstanceKey error fail forward key processDefinitionVersion processInstanceKey retries tenantId type variables worker

Properties

Readonly bpmnProcessId

bpmnProcessId: string

The bpmn process ID of the job process definition

cancelWorkflow

cancelWorkflow: (() => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)

Cancel the workflow.

Type declaration

    • (): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

    • Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

complete

complete: ((updatedVariables?) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">)

Complete the job with a success, optionally passing in a state update to merge with the process variables on the broker.

Type declaration

    • (updatedVariables?): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

    • Parameters

      Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

Readonly customHeaders

customHeaders: Readonly<CustomHeaderShape>

A set of custom headers defined during modelling

Readonly deadline

deadline: string

Epoch milliseconds

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

error

error: ErrorJobOutcome

Report a business error (i.e. non-technical) that occurs while processing a job. The error is handled in the process by an error catch event. If there is no error catch event with the specified errorCode then an incident will be raised instead.

fail

fail: {
    (errorMessage, retries?): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
    (failureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
}

Fail the job with an informative message as to the cause. Optionally, pass in a value remaining retries. If no value is passed for retries then the current retry count is decremented. Pass in 0for retries to raise an incident in Operate. Optionally, specify a retry backoff period in milliseconds. Default is 0ms (immediate retry) if not specified.

Type declaration

forward

forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT")

Mark this job as forwarded to another system for completion. No action is taken by the broker. This method releases worker capacity to handle another job.

Type declaration

    • (): "JOB_ACTION_ACKNOWLEDGEMENT"

    • Returns "JOB_ACTION_ACKNOWLEDGEMENT"

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 retries

retries: number

Readonly tenantId

tenantId: string

The tenantId of the job in a multi-tenant cluster

Readonly type

type: string

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

Readonly variables

variables: Readonly<WorkerInputVariables>

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

On This Page

Generated using TypeDoc