Package io.nitric.api.queue

Class 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 = new 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 Detail

      • Queues

        public Queues()

    • Method Detail

      • queue

        public Queue queue​(String name)
        Create a new queue with the given name.
        Parameters:
        name - the name of the queue (required)
        Returns:
        a new queue

      • getServiceStub

        public static io.nitric.proto.queue.v1.QueueServiceGrpc.QueueServiceBlockingStub getServiceStub()
        Return the Membrane GRPC Queue Service Stub.
        Returns:
        the Membrane GRPC Queue Service Stub

      • setServiceStub

        public static void setServiceStub​(io.nitric.proto.queue.v1.QueueServiceGrpc.QueueServiceBlockingStub stub)
        Set the Membrane GRPC Queue Service stub.
        Parameters:
        stub - the Membrane GRPC Queue Service stub