Package io.nitric.api.queue

Provides the Queue Service API.

The example below illustrates the Queue API.

 import io.nitric.api.queue.Queues;
 import io.nitric.api.queue.Task;
 import io.nitric.api.queue.ReceivedTask;
 ...

 String orderId = ...
 String serialNumber = ...

 var payload = Map.of("orderId", orderId, "serialNumber", serialNumber);
 var task = Task.build(payload);

 // Send a task to the 'shipping' queue
 var queue = Queues.queue("shipping");
 queue.send(task);

 // Receive a list of tasks from the 'shipping' queue
 List<ReceivedTask> tasks = queue.receive(100);

 // Complete the first shipping task
 var shippingTask = tasks.get(0);
 shippingTask.complete();
 

Class Summary

Class	Description
FailedTask	Provides a Queue API failed task class.
FailedTask.Builder	Provides a FailedTask builder class.
Queue	Provides a Queue API queue class.
Queues	Provides the Queue API client.
ReceivedTask	Provides a Queue API Received Task class.
Task	Provides a Queue API Task class.
Task.Builder	Provides a Task builder class.