Queueable API

Apex classes QueueableBuilder.cls, QueueableManager.cls, and QueueableJob.cls.

For testing patterns and best practices, see Testing Async Jobs.

Common Queueable example:

QueueableJob job = new MyQueueableJob();
Async.Result result = Async.queueable(job)
	.priority(5)
	.delay(2)
	.continueOnJobExecuteFail()
	.enqueue();

Returns result.customJobId containing MyQueueableJob's unique Custom Job Id.

Common QueueableJob class example:

public class AccountProcessorJob extends QueueableJob {
	public override void work() {
		// Get job context
		Async.QueueableJobContext ctx = Async.getQueueableJobContext();
	}
}

Common Finalizer class example:

private class ProcessorFinalizer extends QueueableJob.Finalizer {
	public override void work() {
		// Get finalizer context
		FinalizerContext finalizerCtx = Async.getQueueableJobContext().finalizerCtx;
	}
}

Methods

The following are methods for using Async with Queueable jobs:

INIT

• queueable(QueueableJob job)

Build

• asyncOptions(AsyncOptions asyncOptions)
• delay(Integer delay)
• priority(Integer priority)
• continueOnJobEnqueueFail()
• continueOnJobExecuteFail()
• rollbackOnJobExecuteFail()
• deepClone()
• chain()
• chain(QueueableJob job)
• asSchedulable()
• mockId(String mockId)

Execute

• enqueue()
• attachFinalizer()

Context

• getQueueableJobContext()
• getQueueableChainSchedulableId()
• getCurrentQueueableChainState()

INIT

queueable

Constructs a new QueueableBuilder instance with the specified queueable job.

Signature

Async queueable(QueueableJob job);

Example

Async.queueable(new MyQueueableJob());

Build

asyncOptions

Sets AsyncOptions for the queueable job. Cannot be used with delay().

Signature

QueueableBuilder asyncOptions(AsyncOptions asyncOptions);

Example

AsyncOptions options = new AsyncOptions();
Async.queueable(new MyQueueableJob())
	.asyncOptions(options);

delay

Sets a delay in minutes before the job executes. Cannot be used with asyncOptions().

Signature

QueueableBuilder delay(Integer delay);

Example

Async.queueable(new MyQueueableJob())
	.delay(5);  // Execute in 5 minutes

priority

Sets the priority for the queueable job. Lower numbers = higher priority.

Signature

QueueableBuilder priority(Integer priority);

Example

Async.queueable(new MyQueueableJob())
	.priority(1);  // High priority

continueOnJobEnqueueFail

Allows the job chain to continue even if this job fails to enqueue.

Signature

QueueableBuilder continueOnJobEnqueueFail();

Example

Async.queueable(new MyQueueableJob())
	.continueOnJobEnqueueFail();

continueOnJobExecuteFail

Allows the job chain to continue even if this job fails during execution.

Signature

QueueableBuilder continueOnJobExecuteFail();

Example

Async.queueable(new MyQueueableJob())
	.continueOnJobExecuteFail();

rollbackOnJobExecuteFail

Rolls back any DML operations if this job fails during execution.

Signature

QueueableBuilder rollbackOnJobExecuteFail();

Example

Async.queueable(new MyQueueableJob())
	.rollbackOnJobExecuteFail();

deepClone

Clones provided QueueableJob by value for all the member variables. By default only primitive member variables (String, Boolean, ...) are cloned by value. Deeper explanation is here.

Signature

QueueableBuilder deepClone();

Example

Async.queueable(new MyQueueableJob())
	.deepClone();

chain

Adds the Queueable Job to the chain without enqueing it. All jobs in chain will be enqueued once enqueue() method is invoked.

Signature

QueueableBuilder chain();

Example

Async.Result result = Async.queueable(new MyQueueableJob())
	.chain();

Returns result.customJobId containing MyQueueableJob's unique Custom Job Id.

chain next job

Adds the Queueable Job to the chain after previous job. All jobs in chain will be enqueued once enqueue() method is invoked.

Signature

QueueableBuilder chain(QueueableJob job);

Example

Async.Result result = Async.queueable(new MyQueueableJob())
	.chain(new MyOtherQueueableJob());

Returns result.customJobId containing MyOtherQueueableJob's unique Custom Job Id. To obtain MyQueueableJob's Id, use chain() method separately.

asSchedulable

Converts the queueable builder to a schedulable builder for cron-based scheduling. See Schedulable API for scheduling options.

Signature

SchedulableBuilder asSchedulable();

Example

Async.queueable(new MyQueueableJob())
	.asSchedulable();

mockId

Sets a mock identifier for testing with AsyncMock. When the job executes during a test, the framework will inject the corresponding mock context. See AsyncMock API for details.

Signature

QueueableBuilder mockId(String mockId);

Example

// For queueable context mocking
AsyncMock.whenQueueable('account-creator')
	.thenReturn(new AsyncMock.MockQueueableContext());

Async.queueable(new AccountCreatorJob())
	.mockId('account-creator')
	.enqueue();

// For finalizer mocking, use mockId when attaching finalizer inside work()
// See AsyncMock API for finalizer patterns

Execute

enqueue

Enqueues the queueable job with the configured options. Returns an Async.Result.

Signature

Async.Result enqueue();

Example

Async.Result result = Async.queueable(new MyQueueableJob())
	.priority(5)
	.enqueue();

Result properties:

Property	Description
salesforceJobId	Salesforce Job Id of either Queueable Job or Initial Queueable Chain Schedulable (empty if job was not the enqueued one in chain)
customJobId	Unique Custom Job Id
asyncType	Async.AsyncType.QUEUEABLE
queueableChainState	Chain state object (see below)

queueableChainState properties:

Property	Description
jobs	All jobs in chain including finalizers and processed jobs
nextSalesforceJobId	Salesforce Job Id that will run next from chain
nextCustomJobId	Custom Job Id that will run next from chain
enqueueType	How the chain was enqueued: EXISTING_CHAIN, NEW_CHAIN, or INITIAL_QUEUEABLE_CHAIN_SCHEDULABLE

attachFinalizer

Attaches a finalizer job to run after the current job completes. Can only be called within a QueueableChain context.

Signature

Async.Result attachFinalizer();

Example

// Inside a QueueableJob's work() method
Async.Result result = Async.queueable(new MyFinalizerJob())
	.attachFinalizer();

Returns result.customJobId containing the finalizer's unique Custom Job Id.

Context

getQueueableJobContext

Gets the current queueable job context, providing access to job information and Salesforce QueueableContext.

Signature

Async.QueueableJobContext getQueueableJobContext();

Example

Async.QueueableJobContext ctx = Async.getQueueableJobContext();

Context properties:

Property	Description
ctx.currentJob	Current QueueableJob instance
ctx.queueableCtx	Salesforce QueueableContext
ctx.finalizerCtx	Salesforce FinalizerContext (available in finalizers)

getQueueableChainSchedulableId

Gets the ID of the initial Queueable Chain Schedulable if the current execution is part of a scheduled-based chain.

Signature

Id getQueueableChainSchedulableId();

Example

Id schedulableId = Async.getQueueableChainSchedulableId();

Returns the Id of the Initial Queueable Chain Schedulable.

getCurrentQueueableChainState

Gets details about the current Queueable Chain.

Signature

QueueableChainState getCurrentQueueableChainState();

Example

QueueableChainState currentChain = Async.getCurrentQueueableChainState();

Chain state properties:

Property	Description
jobs	All jobs in chain including processed ones and finalizers
nextSalesforceJobId	Salesforce Job Id that will run next (empty if chain not enqueued)
nextCustomJobId	Custom Job Id that will run next from chain
enqueueType	Empty until set during enqueue() method