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

    Class TerminalJobError

    A terminal job failure: retrying will not help. Mapped to throwJobError, which is caught by a matching BPMN error boundary event or — if uncaught — raises an incident.

    Hierarchy

    • YieldableError<this> & {} & Readonly<
          {
              cause?: unknown;
              code: string;
              message: string;
              variables?: { readonly [key: string]: unknown };
          },
      >
      • TerminalJobError
    Index
    • Parameters

      • args: {
            cause?: unknown;
            code: string;
            message: string;
            variables?: { readonly [key: string]: unknown };
        }
        • Optional Readonlycause?: unknown
        • Readonlycode: string

          The BPMN error code matched against an error catch event.

        • Readonlymessage: string
        • Optional Readonlyvariables?: { readonly [key: string]: unknown }

          Optional variables to instantiate at the error catch event's scope.

      Returns TerminalJobError

    code: string

    The BPMN error code matched against an error catch event.

    variables?: { readonly [key: string]: unknown }

    Optional variables to instantiate at the error catch event's scope.