Sign in
Querator V1

Update a queue

Update the specifics of a queue. Reducing the number of partitions will not delete the existing partitions. Consumers will continue to consume from the existing partitions until there are no messages left to consume. The partitions will be deleted at some later date time.

post/v1/queue.update

Response

namestring

The name of the queue

requested_partitionsinteger

The number of partitions this queue has requested. This might be different than the number of currently active partitions as the system grows or contracts the number of partitions.

actual_partitionsinteger

The actual number of partitions currently being services by this queue. This number will adjust as the service attempts to bring the number of partitions to match the requested_partitions

createdstring date-time

The date the queue was created

updatedstring date-time

The date the queue was last updated

dead_queuestring

The name of the dead letter queue for this queue. If this is a dead letter queue then this field will be empty when retrieved via /queue.list

referencestring

This is a user supplied field which could contain metadata or specify who owns this queue

reserve_timeoutstring

The default reservation timeout for this queue. Can be overridded when a message is queued via /queue.produce

deadlinestring

How long the message can wait in the queue regardless of attempts before it is moved to the dead letter queue.

max_attemptsstring

The maximum number of times this message can be defered by a consumer before it is placed in the dead letter queue. This includes cases where the 'deadline' was exceeded and the message was retried.

empty_deadlinestring

How long the queue can remain empty before it's deleted by Querator. queue is never deleted if this value is empty.

Example response

{
  "actual_partitions": 5,
  "reserve_timeout": "3m",
  "deadline": "24h",
  "empty_deadline": "30d"
}

Changes