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

    Type Alias JobSearchResult

    type JobSearchResult = {
        creationTime?: string;
        customHeaders: { [key: string]: string };
        deadline?: string | null;
        deniedReason?: string | null;
        elementId: ElementId | null;
        elementInstanceKey: ElementInstanceKey;
        endTime?: string | null;
        errorCode?: string | null;
        errorMessage?: string | null;
        hasFailedWithRetriesLeft: boolean;
        isDenied?: boolean | null;
        jobKey: JobKey;
        kind: JobKindEnum;
        lastUpdateTime?: string;
        listenerEventType: JobListenerEventTypeEnum;
        processDefinitionId: ProcessDefinitionId;
        processDefinitionKey: ProcessDefinitionKey;
        processInstanceKey: ProcessInstanceKey;
        retries: number;
        rootProcessInstanceKey: ProcessInstanceKey | null;
        state: JobStateEnum;
        tenantId: TenantId;
        type: string;
        worker: string;
    }
    Index

    Properties

    creationTime? customHeaders deadline? deniedReason? elementId elementInstanceKey endTime? errorCode? errorMessage? hasFailedWithRetriesLeft isDenied? jobKey kind lastUpdateTime? listenerEventType processDefinitionId processDefinitionKey processInstanceKey retries rootProcessInstanceKey state tenantId type worker

    Properties

    creationTime?: string

    When the job was created. Field is present for jobs created after 8.9.

    customHeaders: { [key: string]: string }

    A set of custom headers defined during modelling.

    deadline?: string | null

    If the job has been activated, when it will next be available to be activated.

    deniedReason?: string | null

    The reason provided by the user task listener for denying the work.

    elementId: ElementId | null

    The element ID associated with the job. May be missing on job failure.

    elementInstanceKey: ElementInstanceKey

    The element instance key associated with the job.

    endTime?: string | null

    End date of the job. This is null if the job is not in an end state yet.

    errorCode?: string | null

    The error code provided for a failed job.

    errorMessage?: string | null

    The error message that provides additional context for a failed job.

    hasFailedWithRetriesLeft: boolean

    Indicates whether the job has failed with retries left.

    isDenied?: boolean | null

    Indicates whether the user task listener denies the work.

    jobKey: JobKey

    The key, a unique identifier for the job.

    kind: JobKindEnum
    lastUpdateTime?: string

    When the job was last updated. Field is present for jobs created after 8.9.

    listenerEventType: JobListenerEventTypeEnum
    processDefinitionId: ProcessDefinitionId

    The process definition ID associated with the job.

    processDefinitionKey: ProcessDefinitionKey

    The process definition key associated with the job.

    processInstanceKey: ProcessInstanceKey

    The process instance key associated with the job.

    retries: number

    The amount of retries left to this job.

    rootProcessInstanceKey: ProcessInstanceKey | null

    The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later.

    state: JobStateEnum
    tenantId: TenantId
    type: string

    The type of the job.

    worker: string

    The name of the worker of this job.

    Settings

    Member Visibility

    On This Page

    Properties