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

    Interface EnrichedActivatedJob

    Enriched job type with convenience methods.

    interface EnrichedActivatedJob {
        acknowledged?: boolean;
        customHeaders: { [key: string]: unknown };
        deadline: number;
        elementId: ElementId;
        elementInstanceKey: ElementInstanceKey;
        jobKey: JobKey;
        kind: JobKindEnum;
        listenerEventType: JobListenerEventTypeEnum;
        log: Logger;
        modifyJobTimeout: (
            __namedParameters: { newTimeoutMs: number },
        ) => Promise<void>;
        modifyRetries: (__namedParameters: { retries: number }) => Promise<void>;
        processDefinitionId: ProcessDefinitionId;
        processDefinitionKey: ProcessDefinitionKey;
        processDefinitionVersion: number;
        processInstanceKey: ProcessInstanceKey;
        retries: number;
        tags?: TagSet;
        tenantId: TenantId;
        type: string;
        userTask?: {
            action?: string;
            assignee?: string | null;
            candidateGroups?: string[];
            candidateUsers?: string[];
            changedAttributes?: string[];
            dueDate?: string | null;
            followUpDate?: string | null;
            formKey?: FormKey;
            priority?: number | null;
            userTaskKey?: UserTaskKey | null;
        };
        variables: { [key: string]: unknown };
        worker: string;
        cancelWorkflow(): Promise<"JOB_ACTION_RECEIPT">;
        complete(variables?: { [k: string]: any }): Promise<"JOB_ACTION_RECEIPT">;
        error(error: JobErrorRequest): Promise<"JOB_ACTION_RECEIPT">;
        fail(body: any): Promise<"JOB_ACTION_RECEIPT">;
        ignore(): Promise<"JOB_ACTION_RECEIPT">;
    }

    Hierarchy

    • ActivatedJobResult
      • EnrichedActivatedJob
    Index

    Properties

    acknowledged? customHeaders deadline elementId elementInstanceKey jobKey kind listenerEventType log modifyJobTimeout modifyRetries processDefinitionId processDefinitionKey processDefinitionVersion processInstanceKey retries tags? tenantId type userTask? variables worker

    Methods

    cancelWorkflow complete error fail ignore

    Properties

    acknowledged?: boolean

    Set true once any acknowledgement method is invoked.

    customHeaders: { [key: string]: unknown }

    A set of custom headers defined during modelling; returned as a serialized JSON document.

    deadline: number

    When the job can be activated again, sent as a UNIX epoch timestamp.

    elementId: ElementId

    The associated task element ID.

    elementInstanceKey: ElementInstanceKey
    jobKey: JobKey

    The key, a unique identifier for the job.

    kind: JobKindEnum
    listenerEventType: JobListenerEventTypeEnum
    log: Logger
    modifyJobTimeout: (__namedParameters: { newTimeoutMs: number }) => Promise<void>

    Extend the timeout for the job by setting a new timeout

    modifyRetries: (__namedParameters: { retries: number }) => Promise<void>
    processDefinitionId: ProcessDefinitionId

    The bpmn process ID of the job's process definition.

    processDefinitionKey: ProcessDefinitionKey

    The key of the job's process definition.

    processDefinitionVersion: number

    The version of the job's process definition.

    processInstanceKey: ProcessInstanceKey

    The job's process instance key.

    retries: number

    The amount of retries left to this job (should always be positive).

    tags?: TagSet
    tenantId: TenantId

    The ID of the tenant that owns the job.

    type: string

    The type of the job (should match what was requested).

    userTask?: {
        action?: string;
        assignee?: string | null;
        candidateGroups?: string[];
        candidateUsers?: string[];
        changedAttributes?: string[];
        dueDate?: string | null;
        followUpDate?: string | null;
        formKey?: FormKey;
        priority?: number | null;
        userTaskKey?: UserTaskKey | null;
    }

    Contains properties of a user task.

    Type Declaration

    • Optionalaction?: string

      The action performed on the user task.

    • Optionalassignee?: string | null

      The user assigned to the task.

    • OptionalcandidateGroups?: string[]

      The groups eligible to claim the task.

    • OptionalcandidateUsers?: string[]

      The users eligible to claim the task.

    • OptionalchangedAttributes?: string[]

      The attributes that were changed in the task.

    • OptionaldueDate?: string | null

      The due date of the user task in ISO 8601 format.

    • OptionalfollowUpDate?: string | null

      The follow-up date of the user task in ISO 8601 format.

    • OptionalformKey?: FormKey

      The key of the form associated with the user task.

    • Optionalpriority?: number | null

      The priority of the user task.

    • OptionaluserTaskKey?: UserTaskKey | null

      The unique key identifying the user task.

    variables: { [key: string]: unknown }

    All variables visible to the task scope, computed at activation time.

    worker: string

    The name of the worker which activated this job.

    Methods

    • Parameters

      • Optionalvariables: { [k: string]: any }

      Returns Promise<"JOB_ACTION_RECEIPT">

    • Parameters

      • body: any

      Returns Promise<"JOB_ACTION_RECEIPT">

    Settings

    Member Visibility

    On This Page

    Properties
    Methods