Package io.nitric.api.queue

Class Queues

java.lang.Object

io.nitric.api.queue.Queues

public class Queues
extends Object

Provides the Queue API client.

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();
 

See Also:

Queue, Task

Constructor Summary

Constructors

Constructor	Description
Queues()

Method Summary

Modifier and Type	Method	Description
static Queue	queue(String name)	Create a new queue with the given name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Queues

public Queues()

Method Detail

queue

public static Queue queue(String name)

Create a new queue with the given name.

Parameters:

name - the name of the queue (required)

Returns:

a new queue