definitions

Runtime queue definitions controlling behavior such as pausing, resuming, and pending-job cancellation.

Source path: libraries/queue/src/queue-definition.controller.ts

Module file: queue.module.ts

Introduction

Queue definitions describe how a queue behaves at runtime rather than just naming the queue. This is the operational surface administrators use to pause traffic, resume processing, or cancel still-pending jobs in a specific definition.

Because definitions sit between logical queues and actual job execution, they are where most traffic-shaping actions happen without deleting historical job data.

HTTP Endpoints

7 endpoints

List queue definitions.

Get one queue definition.

Params: id (int)

Update a queue definition.

Params: id (int)

Pause a queue definition.

Params: id (int)

Resume a paused queue definition.

Params: id (int)

Cancel pending jobs for a definition.

Params: id (int)

Delete definitions in bulk.

Body

Field	Type	Required	Notes
ids	number[]	yes	—