schema.json

{
  "$id": "https://raw.githubusercontent.com/roadrunner-server/jobs/refs/heads/master/schema.json",
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "description": "All the valid configuration parameters for the jobs plugin for RoadRunner.",
  "title": "roadrunner-jobs",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "num_pollers": {
      "description": "Number of threads which will try to obtain jobs from the priority queue. Default is the number of workers in the pool +1. **Deprecated:** This will be removed in a future version.",
      "type": "integer",
      "minimum": 1,
      "examples": [
        10,
        32
      ],
      "deprecated": true
    },
    "timeout": {
      "description": "Request timeout (in seconds) when attempting to send jobs to the queue. If zero or omitted, this defaults to 60 seconds.",
      "type": "integer",
      "default": 60
    },
    "pipeline_size": {
      "description": "Size of the internal priority queue. If the internal priority queue is full, you cannot send (push) additional jobs to the queue. If you set this value to zero or omit it, it defaults to 1 million.",
      "type": "integer",
      "default": 1000000,
      "minimum": 0
    },
    "consume": {
      "description": "A list of pipelines to be consumed by the server automatically when starting. You can omit this list if you want to start consuming manually. Each item in this list must be defined as a key under `pipelines`.",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-zA-Z0-9._-]+$"
      }
    },
    "pool": {
      "$ref": "https://raw.githubusercontent.com/roadrunner-server/pool/refs/heads/master/schema.json"
    },
    "pipelines": {
      "description": "List of broker pipelines associated with the configured drivers. This option is not required since you can declare pipelines at runtime. The selected pipeline `driver` must be configured in the root of your configuration file.",
      "type": "object",
      "patternProperties": {
        "additionalProperties": false,
        "^[a-zA-Z0-9._-]+$": {
          "oneOf": [
            {
              "$ref": "https://raw.githubusercontent.com/roadrunner-server/amqp/refs/heads/master/schema.json#/definitions/pipeline"
            },
            {
              "$ref": "https://raw.githubusercontent.com/roadrunner-server/beanstalk/refs/heads/master/schema.json#/definitions/pipeline"
            },
            {
              "$ref": "https://raw.githubusercontent.com/roadrunner-server/boltdb/refs/heads/master/schema.json#/definitions/pipeline"
            },
            {
              "$ref": "https://raw.githubusercontent.com/roadrunner-server/kafka/refs/heads/master/schema.json#/definitions/pipeline"
            },
            {
              "$ref": "https://raw.githubusercontent.com/roadrunner-server/memory/refs/heads/master/schema.json#/definitions/pipeline"
            },
            {
              "$ref": "https://raw.githubusercontent.com/roadrunner-server/nats/refs/heads/master/schema.json#/definitions/pipeline"
            },
            {
              "$ref": "https://raw.githubusercontent.com/roadrunner-server/sqs/refs/heads/master/schema.json#/definitions/pipeline"
            }
          ]
        }
      }
    }
  },
  "definitions": {
    "PipelineProperties": {
      "description": "Common configuration options for queues/pipelines.",
      "priority": {
        "description": "Pipeline priority. If the job pushed to the pipeline has priority set to 0, it will inherit the pipeline's priority.",
        "type": "integer",
        "minimum": 0,
        "default": 10
      },
      "prefetch": {
        "description": "Number of jobs to prefetch from the driver. Please consult the driver for the maximum and default values. For instance, SQS allows only 10.",
        "type": "integer",
        "minimum": 0
      },
      "queue": {
        "type": "string",
        "description": "The name of the queue.",
        "default": "default"
      }
    }
  }
}