For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Type Alias: JobFailRequest

type JobFailRequest = object;

Properties​

errorMessage?​

optional errorMessage?: string;

An optional error message describing why the job failed; if not provided, an empty string is used.

jobLeaseToken?​

optional jobLeaseToken?: JobLeaseToken | null;

The token identifying a leased job's activation, obtained from ActivatedJobResult.jobLeaseToken. For a leased job, the matching token must be supplied to prove the command comes from the worker that holds the current lease; a command with no token is rejected. A command carrying a stale token is likewise rejected, fencing the job against a superseded activation (for example, after the job timed out or failed and was re-activated by another worker). A job that was activated without a lease requires no token.

retries?​

optional retries?: number;

The amount of retries the job should have left

retryBackOff?​

optional retryBackOff?: number;

An optional retry back off for the failed job. The job will not be retryable before the current time plus the back off time. The default is 0 which means the job is retryable immediately.

variables?​

optional variables?: object;

JSON object that will instantiate the variables at the local scope of the job's associated task.

Index Signature​

[key: string]: unknown