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

    Type Alias JobActivationRequest

    type JobActivationRequest = {
        fetchVariable?: string[];
        maxJobsToActivate: number;
        requestTimeout?: number;
        tenantIds?: TenantId[];
        timeout: number;
        type: string;
        worker?: string;
    }
    Index

    Properties

    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.

    maxJobsToActivate: number

    The maximum jobs to activate by this request.

    requestTimeout?: number

    The request will be completed when at least one job is activated or after the requestTimeout (in ms). If the requestTimeout = 0, a default timeout is used. If the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.

    tenantIds?: TenantId[]

    A list of IDs of tenants for which to activate jobs.

    timeout: number

    A job returned after this call will not be activated by another call until the timeout (in ms) has been reached.

    type: string

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

    worker?: string

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