Interface JobCompletionInterface<WorkerOutputVariables>

Type Parameters

  • WorkerOutputVariables

Hierarchy

Properties

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

Type declaration

    • (): Promise<"JOB_ACTION_ACKNOWLEDGEMENT">
    • Cancel the workflow.

      Returns Promise<"JOB_ACTION_ACKNOWLEDGEMENT">

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

Type declaration

    • (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.

      Parameters

      • Optional updatedVariables: WorkerOutputVariables

      Returns 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: {
    (errorMessage: string, retries?: number): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
    (failureConfiguration: JobFailureConfiguration): Promise<JOB_ACTION_ACKNOWLEDGEMENT>;
}

Type declaration

    • (errorMessage: string, retries?: number): 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.

      Parameters

      • errorMessage: string
      • Optional retries: number

      Returns Promise<JOB_ACTION_ACKNOWLEDGEMENT>

    • (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.

      Parameters

      Returns Promise<JOB_ACTION_ACKNOWLEDGEMENT>

forward: (() => "JOB_ACTION_ACKNOWLEDGEMENT")

Type declaration

    • (): "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.

      Returns "JOB_ACTION_ACKNOWLEDGEMENT"

Generated using TypeDoc