Queues
A Queue holds messages for pull consumers.
A Queue holds messages for pull consumers. A consumer leases messages for a visibility timeout, then acks or nacks them; a lease is fenced, so a stale holder cannot ack a message someone else holds. A message leased max_deliveries times moves to the dead-letter queue.
Service Sylphx Events · Resource type events.sylphx.com/Queue · Name pattern orgs/{org}/projects/{project}/envs/{env}/queues/{queue} · Shape spec_status
Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/queues/{queue}. |
uid | string | que_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | QueueSpec | Desired state. Required. |
status | QueueStatus | Observed state. Output only. |
Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a queue. |
GET | list | Lists queues. |
POST | create | Creates a queue. |
PATCH | update | Updates a queue. |
DELETE | delete | Deletes a queue. |
POST | send | Enqueues messages directly, without a Subscription. |
POST | lease | Leases up to max_messages ready messages for the visibility timeout. |
POST | ack | Acknowledges leased messages; each is removed. A lease that is stale (expired or superseded) is reported, not applied. |
POST | nack | Returns leased messages to the Queue after delay; each nack counts as a delivery. |
POST | replay | Moves dead-lettered messages, optionally bounded by dead-letter time, back to ready. |
get
Gets a queue.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue · scope events:read · effect read · Request, response and examples
list
Lists queues.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues · scope events:read · effect read · paginated · Request, response and examples
create
Creates a queue.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues · scope events:write · effect write · Request, response and examples
update
Updates a queue.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue · scope events:write · effect write · Request, response and examples
delete
Deletes a queue.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue · scope events:write · effect destructive · Request, response and examples
send
Enqueues messages directly, without a Subscription.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:send · scope events:publish · effect write · Request, response and examples
lease
Leases up to max_messages ready messages for the visibility timeout.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:lease · scope events:write · effect write · Request, response and examples
ack
Acknowledges leased messages; each is removed. A lease that is stale (expired or superseded) is reported, not applied.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:ack · scope events:write · effect write · Request, response and examples
nack
Returns leased messages to the Queue after delay; each nack counts as a delivery.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:nack · scope events:write · effect write · Request, response and examples
replay
Moves dead-lettered messages, optionally bounded by dead-letter time, back to ready.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/queues/queue:replay · scope events:write · effect write · Request, response and examples