package nitric.proto.queues.v1

Get desktop application:
View/edit binary Protocol Buffers messages

The Nitric Queue Service contract

• rpc Enqueue (QueueEnqueueRequest, QueueEnqueueResponse)

  queues.proto:17

  Send message(s) to a queue

  message QueueEnqueueRequest

  queues.proto:24

  • string queue_name = 1

    The Nitric name for the queue this will automatically be resolved to the provider specific queue identifier.

  • repeated QueueMessage messages = 2

    Array of messages to push to the queue

  message QueueEnqueueResponse

  queues.proto:33

  Response for sending messages to a queue

  • repeated FailedEnqueueMessage failed_messages = 1

    A list of messages that failed to be queued

• rpc Dequeue (QueueDequeueRequest, QueueDequeueResponse)

  queues.proto:19

  Receive message(s) from a queue

  message QueueDequeueRequest

  queues.proto:38

  • string queue_name = 1

    The nitric name for the queue this will automatically be resolved to the provider specific queue identifier.

  • int32 depth = 2

    The max number of messages to pop off the queue, may be capped by provider specific limitations

  message QueueDequeueResponse

  queues.proto:46

  • repeated DequeuedMessage messages = 1

    Array of messages popped off the queue

• rpc Complete (QueueCompleteRequest, QueueCompleteResponse)

  queues.proto:21

  Complete an message previously popped from a queue

  message QueueCompleteRequest

  queues.proto:51

  • string queue_name = 1

    The nitric name for the queue this will automatically be resolved to the provider specific queue identifier.

  • string lease_id = 2

    Lease id of the message to be completed

  message QueueCompleteResponse

  queues.proto:60

  (message has no fields)

Used in: QueueDequeueResponse

• string lease_id = 1

• optional QueueMessage message = 2

Used in: QueueEnqueueResponse

• optional QueueMessage message = 1

  The message that failed to be pushed

• string details = 2

  A description of the failure

An message to be sent to a queue.

Used in: DequeuedMessage, FailedEnqueueMessage, QueueEnqueueRequest

• oneof content

  The queue message contents

  • google.protobuf.Struct struct_payload = 1