Skip to content

QueueResponseDto

Endpoints · All schemas

FieldRequiredDescription
hasUnfinishedWorkYesWhether durable work remains, including delayed, paused and unadmitted work
isPausedYesWhether the queue is paused
nameYesSee definition below
statisticsYesSee definition below

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: QueueName, QueueStatisticsDto

{
  "properties": {
    "hasUnfinishedWork": {
      "description": "Whether durable work remains, including delayed, paused and unadmitted work",
      "type": "boolean"
    },
    "isPaused": {
      "description": "Whether the queue is paused",
      "type": "boolean"
    },
    "name": {
      "$ref": "#/components/schemas/QueueName"
    },
    "statistics": {
      "$ref": "#/components/schemas/QueueStatisticsDto"
    }
  },
  "required": [
    "hasUnfinishedWork",
    "isPaused",
    "name",
    "statistics"
  ],
  "type": "object"
}