Interface CamundaJobWorkerConfig<VariablesDto, CustomHeadersDto>

Request object to send the broker to request jobs for the worker.

interface CamundaJobWorkerConfig<VariablesDto, CustomHeadersDto> {
    autoStart?: boolean;
    customHeadersDto?: Ctor<CustomHeadersDto>;
    fetchVariable?: string[];
    inputVariableDto?: Ctor<VariablesDto>;
    jobHandler: ((job, log) => MustReturnJobActionAcknowledgement);
    logger?: Logger;
    maxJobsToActivate: number;
    pollIntervalMs?: number;
    requestTimeout?: MaybeTimeDuration;
    tenantIds?: string[];
    timeout: MaybeTimeDuration;
    type: string;
    worker: string;
}

Type Parameters

Hierarchy (view full)

Properties

autoStart? customHeadersDto? fetchVariable? inputVariableDto? jobHandler logger? maxJobsToActivate pollIntervalMs? requestTimeout? tenantIds? timeout type worker

Properties

Optional autoStart

autoStart?: boolean

Default: true. Start the worker polling immediately. If set to false, call the worker's start() method to start polling for work.

Optional customHeadersDto

customHeadersDto?: Ctor<CustomHeadersDto>

Optional fetchVariable

fetchVariable?: string[]

A list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned

Optional inputVariableDto

inputVariableDto?: Ctor<VariablesDto>

jobHandler

jobHandler: ((job, log) => MustReturnJobActionAcknowledgement)

Type declaration

Optional logger

logger?: Logger

maxJobsToActivate

maxJobsToActivate: number

The maximum jobs to activate by this request

Optional pollIntervalMs

pollIntervalMs?: number

How often the worker will poll for new jobs. Defaults to 30s

Optional requestTimeout

requestTimeout?: MaybeTimeDuration

The request will be completed when atleast one job is activated or after the requestTimeout. if the requestTimeout = 0, the request will be completed after a default configured timeout in the broker. To immediately complete the request when no job is activated set the requestTimeout to a negative value

Optional tenantIds

tenantIds?: string[]

a list of IDs of tenants for which to activate jobs

timeout

timeout: MaybeTimeDuration

The duration the broker allows for jobs activated by this call to complete before timing them out releasing them for retry on the broker. The broker checks time outs every 30 seconds, so the broker timeout is guaranteed in at-most timeout + 29s be guaranteed.

type

type: string

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

worker

worker: string

The name of the worker activating the jobs, mostly used for logging purposes

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc