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

    Interface JobWorkerConfig<In, Out, Headers>

    interface JobWorkerConfig<
        In extends z.ZodTypeAny = any,
        Out extends z.ZodTypeAny = any,
        Headers extends z.ZodTypeAny = any,
    > {
        autoStart?: boolean;
        customHeadersSchema?: Headers;
        inputSchema?: In;
        jobHandler: (
            job: Job<In, Headers>,
        ) => "JOB_ACTION_RECEIPT" | Promise<"JOB_ACTION_RECEIPT">;
        jobTimeoutMs: number;
        jobType: string;
        maxBackoffTimeMs?: number;
        maxParallelJobs: number;
        outputSchema?: Out;
        pollIntervalMs?: number;
        pollTimeoutMs?: number;
        validateSchemas?: boolean;
        workerName?: string;
    }

    Type Parameters

    • In extends z.ZodTypeAny = any
    • Out extends z.ZodTypeAny = any
    • Headers extends z.ZodTypeAny = any
    Index

    Properties

    autoStart? customHeadersSchema? inputSchema? jobHandler jobTimeoutMs jobType maxBackoffTimeMs? maxParallelJobs outputSchema? pollIntervalMs? pollTimeoutMs? validateSchemas? workerName?

    Properties

    autoStart?: boolean

    Immediately start polling for work - default true

    customHeadersSchema?: Headers

    Zod schema for custom headers in the activated job

    inputSchema?: In

    Zod schema for variables in the activated job

    jobHandler: (
        job: Job<In, Headers>,
    ) => "JOB_ACTION_RECEIPT" | Promise<"JOB_ACTION_RECEIPT">
    jobTimeoutMs: number

    Job activation timeout

    jobType: string

    Zeebe job type

    maxBackoffTimeMs?: number

    Not used; pacing handled by long polling + client backpressure. Present only for migration compatibility.

    maxParallelJobs: number

    concurrency limit

    outputSchema?: Out

    Zod schema for variables in the complete command

    pollIntervalMs?: number

    Backoff between polls - default 1ms

    pollTimeoutMs?: number

    requestTimeout for activation long poll - default 55_000

    validateSchemas?: boolean

    Validate any provided input, output, customheader schema default: false

    workerName?: string

    Optional explicit name

    Settings

    Member Visibility

    On This Page

    Properties