@camunda8/sdk
    Preparing search index...

    Interface JobCompletionInterfaceRest<WorkerOutputVariables>

    interface JobCompletionInterfaceRest<WorkerOutputVariables> {
        cancelWorkflow: () => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">;
        complete: (
            updatedVariables?: WorkerOutputVariables,
        ) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">;
        error: (
            error: ErrorJobWithVariables,
        ) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">;
        fail: (
            failureConfiguration: JobFailureConfiguration,
        ) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">;
        forward: () => "JOB_ACTION_ACKNOWLEDGEMENT";
        modifyJobTimeout: (
            __namedParameters: { newTimeoutMs: number },
        ) => Promise<Response<string>>;
    }

    Type Parameters

    • WorkerOutputVariables
    Index

    Properties

    cancelWorkflow: () => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

    Cancel the workflow.

    complete: (
        updatedVariables?: WorkerOutputVariables,
    ) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

    Complete the job with a success, optionally passing in a state update to merge with the process variables on the broker.

    error: (error: ErrorJobWithVariables) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

    Report a business error (i.e. non-technical) that occurs while processing a job. The error is handled in the process by an error catch event. If there is no error catch event with the specified errorCode then an incident will be raised instead.

    fail: (
        failureConfiguration: JobFailureConfiguration,
    ) => Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

    Fail the job with an informative message as to the cause. Optionally, pass in a value remaining retries. If no value is passed for retries then the current retry count is decremented. Pass in 0for retries to raise an incident in Operate. Optionally, specify a retry backoff period in milliseconds. Default is 0ms (immediate retry) if not specified.

    forward: () => "JOB_ACTION_ACKNOWLEDGEMENT"

    Mark this job as forwarded to another system for completion. No action is taken by the broker. This method releases worker capacity to handle another job.

    modifyJobTimeout: (
        __namedParameters: { newTimeoutMs: number },
    ) => Promise<Response<string>>

    Extend the timeout for the job by setting a new timeout