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

    Interface ActivateJobsStreamOptions<R>

    interface ActivateJobsStreamOptions<R = never> {
        activationRetrySchedule?: Schedule<unknown, DomainError, never, R>;
        fetchVariables?: readonly string[];
        jobTimeout?: Input;
        maxJobsToActivate?: number;
        pollInterval?: Input;
        requestTimeout?: Input;
        workerName?: string;
    }

    Type Parameters

    • R = never

    Hierarchy (View Summary)

    Index
    activationRetrySchedule? fetchVariables? jobTimeout? maxJobsToActivate? pollInterval? requestTimeout? workerName?
    activationRetrySchedule?: Schedule<unknown, DomainError, never, R>

    Schedule used to back off and retry a failed activation request (transport outage, broker restart, transient server error). Runs on the Effect Clock. When omitted, an activation failure fails the stream.

    fetchVariables?: readonly string[]

    Restrict activation to these variable names.

    jobTimeout?: Input

    Per-job activation lock timeout (server-side). Default 60 seconds.

    maxJobsToActivate?: number

    Max jobs to activate per poll (the activation batch size). Default 10.

    pollInterval?: Input

    Delay between polls that returned no jobs, on the Effect Clock (so it is virtual under TestClock). A poll that returns jobs schedules the next poll immediately. Default 1 second.

    requestTimeout?: Input

    Long-poll request timeout. 0 (the default) lets the broker hold the request for its configured default; a negative value returns immediately when idle.

    workerName?: string

    Worker name recorded on the activation request. Defaults to effect-worker-<type>-<n>, where <n> is an incrementing per-process counter.

    Settings
    Member Visibility

    On This Page
    Properties