Ably · Schema

queue

RealtimeWebSocketsPub/SubMessagingStreamingPush NotificationsChatLiveSync

Properties

Name Type Description
name string A friendly name for your queue.
ttl integer TTL in minutes.
maxLength integer Message limit in number of messages.
region string The data center region. US East (Virginia) or EU West (Ireland). Values are `us-east-1-a` or `eu-west-1-a`.
View JSON Schema on GitHub

JSON Schema

ably-queue-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/queue",
  "title": "queue",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "description": "A friendly name for your queue.",
      "example": "My queue"
    },
    "ttl": {
      "type": "integer",
      "description": "TTL in minutes.",
      "example": 60
    },
    "maxLength": {
      "type": "integer",
      "description": "Message limit in number of messages.",
      "example": 10000
    },
    "region": {
      "type": "string",
      "description": "The data center region. US East (Virginia) or EU West (Ireland). Values are `us-east-1-a` or `eu-west-1-a`.",
      "example": "us-east-1-a"
    }
  },
  "required": [
    "name",
    "ttl",
    "maxLength",
    "region"
  ]
}