Sign in
Querator V1

Reserve messages from the queue

Reserve a message from the requested queue. When a message is reserved by a consumer, that consumer gains exclusive rights to the message. No other consumer will be provided the same message unless the reserve_deadline has expired and the consumer with the reservation has not marked the message via /queue.complete or /queue.defer

If a message is not acknowledge via /queue.complete within the reserve_deadline period it will be offered to another consumer.

Timeout Semantics

The call will return when a reservation is successful or when request_timeout has been reached. If the call returns with a 454 Retry Request response code, this means there were no items in the queue and the request_timeout was reached. In this case the client should retry the reserve request.

The client should NOT cancel the request before request_timeout has been reached. If the call fails to return after request_timeout is reached the client can safely cancel the request.

post/v1/queue.reserve

Request body

queue_namestring required

The name of the queue

client_idstring required

A unique id which identifies this client. Duplicate client id's are not allowed

request_timeoutstring required

The duration this request should block before the client will cancel the request.

batch_sizeinteger

The maxium number of items to be reserved for this request

Example request

{
  "client_id": "client-1234",
  "request_timeout": "30s"
}

Response

queue_namestring required

The name of the queue the reserved items are from

partitioninteger required

Partition the reserved items are from

Changes