## Attributes (14)

- consumer-count - The number of consumers consuming messages from this queue.

  Type | INT
  Is the attribute nillable? | true
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "INT"
          },
          "description" : "The number of consumers consuming messages from this queue.",
          "expressions-allowed" : false,
          "required" : false,
          "nillable" : true,
          "stability" : "default",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- dead-letter-address - The address to send the queue's dead messages to.

  Type | STRING
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The address to send the queue's dead messages to.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- delivering-count - The number of messages that this queue is currently delivering to its consumers.

  Type | INT
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "INT"
          },
          "description" : "The number of messages that this queue is currently delivering to its consumers.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- durable - Defines whether the queue is durable.

  Type | BOOLEAN
  Default Value | true
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "BOOLEAN"
          },
          "description" : "Defines whether the queue is durable.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : true,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "configuration",
          "restart-required" : null,
          "capability-reference" : null
      }

- expiry-address - The address to send the queue's expired messages to.

  Type | STRING
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The address to send the queue's expired messages to.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- filter - A queue message filter definition. An undefined or empty filter will match all messages.

  Type | STRING
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "A queue message filter definition. An undefined or empty filter will match all messages.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "min-length" : 0,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "configuration",
          "restart-required" : null,
          "capability-reference" : null
      }

- id - The id of the queue.

  Type | LONG
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The id of the queue.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- message-count - The number of messages currently in this queue.

  Type | LONG
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The number of messages currently in this queue.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- messages-added - The number of messages added to this queue since it was created.

  Type | LONG
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The number of messages added to this queue since it was created.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- paused - Whether the queue is paused.

  Type | BOOLEAN
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "BOOLEAN"
          },
          "description" : "Whether the queue is paused.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- queue-address - The queue address defines what address is used for routing messages.

  Type | STRING
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The queue address defines what address is used for routing messages.",
          "expressions-allowed" : true,
          "required" : true,
          "nillable" : false,
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "configuration",
          "restart-required" : null,
          "capability-reference" : null
      }

- routing-type - Routing type of the queue.

  Type | STRING
  Default Value | MULTICAST
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-only
  Allowed Values | MULTICAST ANYCAST
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "Routing type of the queue.",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "MULTICAST",
          "allowed" : [
              "MULTICAST",
              "ANYCAST"
          ],
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "configuration",
          "restart-required" : null,
          "capability-reference" : null
      }

- scheduled-count - The number of scheduled messages in this queue.

  Type | LONG
  Where is the attribute stored? | runtime
  Access Type | metric
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          },
          "description" : "The number of scheduled messages in this queue.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "metric",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

- temporary - Whether the queue is temporary.

  Type | BOOLEAN
  Where is the attribute stored? | runtime
  Access Type | read-only
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "BOOLEAN"
          },
          "description" : "Whether the queue is temporary.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-type" : "read-only",
          "storage" : "runtime",
          "restart-required" : null,
          "capability-reference" : null
      }

## Operations (27)

- add - Operation adding a core queue.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  durable | BOOLEAN | false | true | true | Defines whether the queue is durable.
  filter | STRING | false | true |  | A queue message filter definition. An undefined or empty filter will match all messages.
  queue-address | STRING | true | true |  | The queue address defines what address is used for routing messages.
  routing-type | STRING | false | true | MULTICAST | Routing type of the queue.

  Raw DMR model |
      {
          "operation-name" : "add",
          "description" : "Operation adding a core queue.",
          "request-properties" : {
              "durable" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "Defines whether the queue is durable.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : true,
                  "stability" : "default"
              },
              "filter" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "A queue message filter definition. An undefined or empty filter will match all messages.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 0,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "queue-address" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The queue address defines what address is used for routing messages.",
                  "expressions-allowed" : true,
                  "required" : true,
                  "nillable" : false,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "routing-type" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "Routing type of the queue.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "MULTICAST",
                  "allowed" : [
                      "MULTICAST",
                      "ANYCAST"
                  ],
                  "stability" : "default"
              }
          },
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : false
      }

- change-message-priority - Change the priority of the message corresponding to the given message-id.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  message-id | LONG | true | false |  | The message ID.
  new-priority | INT | true | false |  | The new priority (between 0 and 9).

  ### Reply properties

  True if the message priority was changed, false otherwise.
  Type
    BOOLEAN

  Raw DMR model |
      {
          "operation-name" : "change-message-priority",
          "description" : "Change the priority of the message corresponding to the given message-id.",
          "request-properties" : {
              "message-id" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The message ID.",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "stability" : "default"
              },
              "new-priority" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "INT"
                  },
                  "description" : "The new priority (between 0 and 9).",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "min" : 0,
                  "max" : 9,
                  "stability" : "default"
              }
          },
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "BOOLEAN"
              },
              "description" : "True if the message priority was changed, false otherwise."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- change-messages-priority - Change the priority of the messages corresponding to the given filter.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  filter | STRING | false | true |  | A message filter. An undefined or empty filter will match all messages.
  new-priority | INT | true | false |  | The new priority (between 0 and 9).

  ### Reply properties

  The number of changed messages.
  Type
    INT

  Raw DMR model |
      {
          "operation-name" : "change-messages-priority",
          "description" : "Change the priority of the messages corresponding to the given filter.",
          "request-properties" : {
              "filter" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "A message filter. An undefined or empty filter will match all messages.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 0,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "new-priority" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "INT"
                  },
                  "description" : "The new priority (between 0 and 9).",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "min" : 0,
                  "max" : 9,
                  "stability" : "default"
              }
          },
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "INT"
              },
              "description" : "The number of changed messages."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- count-messages - Returns the number of the messages in the queue matching the given filter.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  filter | STRING | false | true |  | A message filter. An undefined or empty filter will match all messages.

  ### Reply properties

  Type
    LONG

  Raw DMR model |
      {
          "operation-name" : "count-messages",
          "description" : "Returns the number of the messages in the queue matching the given filter.",
          "request-properties" : {"filter" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A message filter. An undefined or empty filter will match all messages.",
              "expressions-allowed" : true,
              "required" : false,
              "nillable" : true,
              "min-length" : 0,
              "max-length" : 2147483647,
              "stability" : "default"
          }},
          "reply-properties" : {"type" : {
              "TYPE_MODEL_VALUE" : "LONG"
          }},
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- expire-message - Expire the message corresponding to the given message-id.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  message-id | LONG | true | false |  | The message ID.

  ### Reply properties

  True if the message was expired, false otherwise.
  Type
    BOOLEAN

  Raw DMR model |
      {
          "operation-name" : "expire-message",
          "description" : "Expire the message corresponding to the given message-id.",
          "request-properties" : {"message-id" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "LONG"
              },
              "description" : "The message ID.",
              "expressions-allowed" : false,
              "required" : true,
              "nillable" : false,
              "stability" : "default"
          }},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "BOOLEAN"
              },
              "description" : "True if the message was expired, false otherwise."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- expire-messages - Expire the messages matching the given filter.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  filter | STRING | false | true |  | A message filter. An undefined or empty filter will match all messages.

  ### Reply properties

  The number of expired messages.
  Type
    INT

  Raw DMR model |
      {
          "operation-name" : "expire-messages",
          "description" : "Expire the messages matching the given filter.",
          "request-properties" : {"filter" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A message filter. An undefined or empty filter will match all messages.",
              "expressions-allowed" : true,
              "required" : false,
              "nillable" : true,
              "min-length" : 0,
              "max-length" : 2147483647,
              "stability" : "default"
          }},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "INT"
              },
              "description" : "The number of expired messages."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- list-consumers-as-json - List all the existing consumers on the queue as a string in JSON format.

  ### Reply properties

  A string in JSON format with the list of all consumers
  Type
    STRING

  Raw DMR model |
      {
          "operation-name" : "list-consumers-as-json",
          "description" : "List all the existing consumers on the queue as a string in JSON format.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A string in JSON format with the list of all consumers"
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- list-delivering-messages - List the messages are currently being delivered.

  ### Reply properties

  A list where each element is a map of message properties to their value.
  Type
    LIST
  Value Type

        {
            "consumerName" => {
                "type" => STRING,
                "description" => "The name of the consumer that the messages are delivered to.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min-length" => 1,
                "max-length" => 2147483647,
                "stability" => "default"
            },
            "elements" => {
                "type" => LIST,
                "description" => "The delivering messages.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min-length" => 0,
                "max-length" => 2147483647,
                "stability" => "default",
                "value-type" => {
                    "messageID" => {
                        "type" => STRING,
                        "description" => "The message ID.",
                        "expressions-allowed" => false,
                        "required" => true,
                        "nillable" => false,
                        "min-length" => 1,
                        "max-length" => 2147483647,
                        "stability" => "default"
                    },
                    "userID" => {
                        "type" => STRING,
                        "description" => "The userID - this is an optional user specified UUID that can be set to identify the message.",
                        "expressions-allowed" => false,
                        "required" => true,
                        "nillable" => false,
                        "min-length" => 1,
                        "max-length" => 2147483647,
                        "stability" => "default"
                    },
                    "address" => {
                        "type" => STRING,
                        "description" => "The address this message is sent to.",
                        "expressions-allowed" => false,
                        "required" => true,
                        "nillable" => false,
                        "min-length" => 1,
                        "max-length" => 2147483647,
                        "stability" => "default"
                    },
                    "type" => {
                        "type" => INT,
                        "description" => "The message type. 0 = Default; 2 = Object; 3 = Text; 4 = Bytes; 5 = Map; 6 = Stream",
                        "expressions-allowed" => false,
                        "required" => true,
                        "nillable" => false,
                        "allowed" => [
                            0,
                            2,
                            3,
                            4,
                            5,
                            6
                        ],
                        "stability" => "default"
                    },
                    "durable" => {
                        "type" => INT,
                        "description" => "Whether this message is durable or not.",
                        "expressions-allowed" => false,
                        "required" => true,
                        "nillable" => false,
                        "stability" => "default"
                    },
                    "expiration" => {
                        "type" => LONG,
                        "description" => "The expiration time of this message.",
                        "expressions-allowed" => false,
                        "required" => true,
                        "nillable" => false,
                        "stability" => "default"
                    },
                    "priority" => {
                        "type" => INT,
                        "description" => "The message priority. Values range from 0 (less priority) to 9 (more priority) inclusive.",
                        "expressions-allowed" => false,
                        "required" => true,
                        "nillable" => false,
                        "min" => 0,
                        "max" => 9,
                        "stability" => "default"
                    }
                }
            }
        }

  Raw DMR model |
      {
          "operation-name" : "list-delivering-messages",
          "description" : "List the messages are currently being delivered.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "LIST"
              },
              "value-type" : {
                  "consumerName" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "STRING"
                      },
                      "description" : "The name of the consumer that the messages are delivered to.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "min-length" : 1,
                      "max-length" : 2147483647,
                      "stability" : "default"
                  },
                  "elements" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "LIST"
                      },
                      "description" : "The delivering messages.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "min-length" : 0,
                      "max-length" : 2147483647,
                      "stability" : "default",
                      "value-type" : {
                          "messageID" : {
                              "type" : {
                                  "TYPE_MODEL_VALUE" : "STRING"
                              },
                              "description" : "The message ID.",
                              "expressions-allowed" : false,
                              "required" : true,
                              "nillable" : false,
                              "min-length" : 1,
                              "max-length" : 2147483647,
                              "stability" : "default"
                          },
                          "userID" : {
                              "type" : {
                                  "TYPE_MODEL_VALUE" : "STRING"
                              },
                              "description" : "The userID - this is an optional user specified UUID that can be set to identify the message.",
                              "expressions-allowed" : false,
                              "required" : true,
                              "nillable" : false,
                              "min-length" : 1,
                              "max-length" : 2147483647,
                              "stability" : "default"
                          },
                          "address" : {
                              "type" : {
                                  "TYPE_MODEL_VALUE" : "STRING"
                              },
                              "description" : "The address this message is sent to.",
                              "expressions-allowed" : false,
                              "required" : true,
                              "nillable" : false,
                              "min-length" : 1,
                              "max-length" : 2147483647,
                              "stability" : "default"
                          },
                          "type" : {
                              "type" : {
                                  "TYPE_MODEL_VALUE" : "INT"
                              },
                              "description" : "The message type. 0 = Default; 2 = Object; 3 = Text; 4 = Bytes; 5 = Map; 6 = Stream",
                              "expressions-allowed" : false,
                              "required" : true,
                              "nillable" : false,
                              "allowed" : [
                                  0,
                                  2,
                                  3,
                                  4,
                                  5,
                                  6
                              ],
                              "stability" : "default"
                          },
                          "durable" : {
                              "type" : {
                                  "TYPE_MODEL_VALUE" : "INT"
                              },
                              "description" : "Whether this message is durable or not.",
                              "expressions-allowed" : false,
                              "required" : true,
                              "nillable" : false,
                              "stability" : "default"
                          },
                          "expiration" : {
                              "type" : {
                                  "TYPE_MODEL_VALUE" : "LONG"
                              },
                              "description" : "The expiration time of this message.",
                              "expressions-allowed" : false,
                              "required" : true,
                              "nillable" : false,
                              "stability" : "default"
                          },
                          "priority" : {
                              "type" : {
                                  "TYPE_MODEL_VALUE" : "INT"
                              },
                              "description" : "The message priority. Values range from 0 (less priority) to 9 (more priority) inclusive.",
                              "expressions-allowed" : false,
                              "required" : true,
                              "nillable" : false,
                              "min" : 0,
                              "max" : 9,
                              "stability" : "default"
                          }
                      }
                  }
              },
              "description" : "A list where each element is a map of message properties to their value."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- list-delivering-messages-as-json - List the messages are currently being delivered as a string in JSON format

  ### Reply properties

  A string in JSON format representing a list where each element is a map of message properties to their value.
  Type
    STRING

  Raw DMR model |
      {
          "operation-name" : "list-delivering-messages-as-json",
          "description" : "List the messages are currently being delivered as a string in JSON format",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A string in JSON format representing a list where each element is a map of message properties to their value."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- list-message-counter-as-html - List the message counter as a string in HTML format.

  ### Reply properties

  A string in HTML format.
  Type
    STRING

  Raw DMR model |
      {
          "operation-name" : "list-message-counter-as-html",
          "description" : "List the message counter as a string in HTML format.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A string in HTML format."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- list-message-counter-as-json - List the message counter as a string in JSON format.

  ### Reply properties

  A string in JSON format.
  Type
    STRING

  Raw DMR model |
      {
          "operation-name" : "list-message-counter-as-json",
          "description" : "List the message counter as a string in JSON format.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A string in JSON format."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- list-message-counter-history-as-html - List the message counter history.

  ### Reply properties

  A string in HTML format.
  Type
    STRING

  Raw DMR model |
      {
          "operation-name" : "list-message-counter-history-as-html",
          "description" : "List the message counter history.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A string in HTML format."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- list-message-counter-history-as-json - List the message counter history as a string in JSON format.

  ### Reply properties

  A string in JSON format
  Type
    STRING

  Raw DMR model |
      {
          "operation-name" : "list-message-counter-history-as-json",
          "description" : "List the message counter history as a string in JSON format.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A string in JSON format"
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- list-messages - List all messages in the queue that match the filter

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  filter | STRING | false | true |  | A message filter. An undefined or empty filter will match all messages.

  ### Reply properties

  A list where each element is a map of message properties to their value.
  Type
    LIST
  Value Type

        {
            "messageID" => {
                "type" => STRING,
                "description" => "The message ID.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min-length" => 1,
                "max-length" => 2147483647,
                "stability" => "default"
            },
            "userID" => {
                "type" => STRING,
                "description" => "The userID - this is an optional user specified UUID that can be set to identify the message.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min-length" => 1,
                "max-length" => 2147483647,
                "stability" => "default"
            },
            "address" => {
                "type" => STRING,
                "description" => "The address this message is sent to.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min-length" => 1,
                "max-length" => 2147483647,
                "stability" => "default"
            },
            "type" => {
                "type" => INT,
                "description" => "The message type. 0 = Default; 2 = Object; 3 = Text; 4 = Bytes; 5 = Map; 6 = Stream",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "allowed" => [
                    0,
                    2,
                    3,
                    4,
                    5,
                    6
                ],
                "stability" => "default"
            },
            "durable" => {
                "type" => INT,
                "description" => "Whether this message is durable or not.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "stability" => "default"
            },
            "expiration" => {
                "type" => LONG,
                "description" => "The expiration time of this message.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "stability" => "default"
            },
            "priority" => {
                "type" => INT,
                "description" => "The message priority. Values range from 0 (less priority) to 9 (more priority) inclusive.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min" => 0,
                "max" => 9,
                "stability" => "default"
            }
        }

  Raw DMR model |
      {
          "operation-name" : "list-messages",
          "description" : "List all messages in the queue that match the filter",
          "request-properties" : {"filter" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A message filter. An undefined or empty filter will match all messages.",
              "expressions-allowed" : true,
              "required" : false,
              "nillable" : true,
              "min-length" : 0,
              "max-length" : 2147483647,
              "stability" : "default"
          }},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "LIST"
              },
              "value-type" : {
                  "messageID" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "STRING"
                      },
                      "description" : "The message ID.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "min-length" : 1,
                      "max-length" : 2147483647,
                      "stability" : "default"
                  },
                  "userID" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "STRING"
                      },
                      "description" : "The userID - this is an optional user specified UUID that can be set to identify the message.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "min-length" : 1,
                      "max-length" : 2147483647,
                      "stability" : "default"
                  },
                  "address" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "STRING"
                      },
                      "description" : "The address this message is sent to.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "min-length" : 1,
                      "max-length" : 2147483647,
                      "stability" : "default"
                  },
                  "type" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "INT"
                      },
                      "description" : "The message type. 0 = Default; 2 = Object; 3 = Text; 4 = Bytes; 5 = Map; 6 = Stream",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "allowed" : [
                          0,
                          2,
                          3,
                          4,
                          5,
                          6
                      ],
                      "stability" : "default"
                  },
                  "durable" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "INT"
                      },
                      "description" : "Whether this message is durable or not.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "stability" : "default"
                  },
                  "expiration" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "LONG"
                      },
                      "description" : "The expiration time of this message.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "stability" : "default"
                  },
                  "priority" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "INT"
                      },
                      "description" : "The message priority. Values range from 0 (less priority) to 9 (more priority) inclusive.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "min" : 0,
                      "max" : 9,
                      "stability" : "default"
                  }
              },
              "description" : "A list where each element is a map of message properties to their value."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- list-messages-as-json - List all messages in the queue that match the filter and return them as a string in JSON format.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  filter | STRING | false | true |  | A message filter. An undefined or empty filter will match all messages.

  ### Reply properties

  A JSON string containing all the messages matching the filter.
  Type
    STRING

  Raw DMR model |
      {
          "operation-name" : "list-messages-as-json",
          "description" : "List all messages in the queue that match the filter and return them as a string in JSON format.",
          "request-properties" : {"filter" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A message filter. An undefined or empty filter will match all messages.",
              "expressions-allowed" : true,
              "required" : false,
              "nillable" : true,
              "min-length" : 0,
              "max-length" : 2147483647,
              "stability" : "default"
          }},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A JSON string containing all the messages matching the filter."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- list-scheduled-messages - List the messages scheduled for delivery.

  ### Reply properties

  A list where each element is a map of message properties to their value.
  Type
    LIST
  Value Type

        {
            "messageID" => {
                "type" => STRING,
                "description" => "The message ID.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min-length" => 1,
                "max-length" => 2147483647,
                "stability" => "default"
            },
            "userID" => {
                "type" => STRING,
                "description" => "The userID - this is an optional user specified UUID that can be set to identify the message.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min-length" => 1,
                "max-length" => 2147483647,
                "stability" => "default"
            },
            "address" => {
                "type" => STRING,
                "description" => "The address this message is sent to.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min-length" => 1,
                "max-length" => 2147483647,
                "stability" => "default"
            },
            "type" => {
                "type" => INT,
                "description" => "The message type. 0 = Default; 2 = Object; 3 = Text; 4 = Bytes; 5 = Map; 6 = Stream",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "allowed" => [
                    0,
                    2,
                    3,
                    4,
                    5,
                    6
                ],
                "stability" => "default"
            },
            "durable" => {
                "type" => INT,
                "description" => "Whether this message is durable or not.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "stability" => "default"
            },
            "expiration" => {
                "type" => LONG,
                "description" => "The expiration time of this message.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "stability" => "default"
            },
            "priority" => {
                "type" => INT,
                "description" => "The message priority. Values range from 0 (less priority) to 9 (more priority) inclusive.",
                "expressions-allowed" => false,
                "required" => true,
                "nillable" => false,
                "min" => 0,
                "max" => 9,
                "stability" => "default"
            }
        }

  Raw DMR model |
      {
          "operation-name" : "list-scheduled-messages",
          "description" : "List the messages scheduled for delivery.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "LIST"
              },
              "value-type" : {
                  "messageID" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "STRING"
                      },
                      "description" : "The message ID.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "min-length" : 1,
                      "max-length" : 2147483647,
                      "stability" : "default"
                  },
                  "userID" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "STRING"
                      },
                      "description" : "The userID - this is an optional user specified UUID that can be set to identify the message.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "min-length" : 1,
                      "max-length" : 2147483647,
                      "stability" : "default"
                  },
                  "address" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "STRING"
                      },
                      "description" : "The address this message is sent to.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "min-length" : 1,
                      "max-length" : 2147483647,
                      "stability" : "default"
                  },
                  "type" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "INT"
                      },
                      "description" : "The message type. 0 = Default; 2 = Object; 3 = Text; 4 = Bytes; 5 = Map; 6 = Stream",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "allowed" : [
                          0,
                          2,
                          3,
                          4,
                          5,
                          6
                      ],
                      "stability" : "default"
                  },
                  "durable" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "INT"
                      },
                      "description" : "Whether this message is durable or not.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "stability" : "default"
                  },
                  "expiration" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "LONG"
                      },
                      "description" : "The expiration time of this message.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "stability" : "default"
                  },
                  "priority" : {
                      "type" : {
                          "TYPE_MODEL_VALUE" : "INT"
                      },
                      "description" : "The message priority. Values range from 0 (less priority) to 9 (more priority) inclusive.",
                      "expressions-allowed" : false,
                      "required" : true,
                      "nillable" : false,
                      "min" : 0,
                      "max" : 9,
                      "stability" : "default"
                  }
              },
              "description" : "A list where each element is a map of message properties to their value."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- list-scheduled-messages-as-json - List the messages scheduled for delivery as a string in JSON format.

  ### Reply properties

  A string in JSON format representing a list where each element is a map of message properties to their value.
  Type
    STRING

  Raw DMR model |
      {
          "operation-name" : "list-scheduled-messages-as-json",
          "description" : "List the messages scheduled for delivery as a string in JSON format.",
          "request-properties" : {},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A string in JSON format representing a list where each element is a map of message properties to their value."
          },
          "stability" : "default",
          "read-only" : true,
          "runtime-only" : true
      }

- move-message - Move the message corresponding to the given message-id to another queue

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  message-id | LONG | true | false |  | The message ID.
  other-queue-name | STRING | true | false |  | The name of the queue to move the message to.
  reject-duplicates | BOOLEAN | false | false |  | Whether to reject messages identified as duplicate.

  ### Reply properties

  True if the message was moved, false otherwise
  Type
    INT

  Raw DMR model |
      {
          "operation-name" : "move-message",
          "description" : "Move the message corresponding to the given message-id to another queue",
          "request-properties" : {
              "message-id" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "LONG"
                  },
                  "description" : "The message ID.",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "stability" : "default"
              },
              "other-queue-name" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The name of the queue to move the message to.",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "reject-duplicates" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "Whether to reject messages identified as duplicate.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "stability" : "default"
              }
          },
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "INT"
              },
              "description" : "True if the message was moved, false otherwise"
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- move-messages - Move the messages corresponding to the given filter to another queue.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  filter | STRING | false | true |  | A message filter. An undefined or empty filter will match all messages.
  other-queue-name | STRING | true | false |  | The name of the queue to move the message to.
  reject-duplicates | BOOLEAN | false | false |  | Whether to reject messages identified as duplicate.

  ### Reply properties

  The number of moved messages.
  Type
    INT

  Raw DMR model |
      {
          "operation-name" : "move-messages",
          "description" : "Move the messages corresponding to the given filter to another queue.",
          "request-properties" : {
              "filter" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "A message filter. An undefined or empty filter will match all messages.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 0,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "other-queue-name" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The name of the queue to move the message to.",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "reject-duplicates" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "BOOLEAN"
                  },
                  "description" : "Whether to reject messages identified as duplicate.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "stability" : "default"
              }
          },
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "INT"
              },
              "description" : "The number of moved messages."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- pause - Pause the queue.

  Raw DMR model |
      {
          "operation-name" : "pause",
          "description" : "Pause the queue.",
          "request-properties" : {},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- remove - Operation removing an existing queue.

  Raw DMR model |
      {
          "operation-name" : "remove",
          "description" : "Operation removing an existing queue.",
          "request-properties" : {},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "restart-required" : "all-services",
          "runtime-only" : false
      }

- remove-message - Remove the message corresponding to the given message-id.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  message-id | LONG | true | false |  | The message ID.

  ### Reply properties

  True if the message was removed, false otherwise.
  Type
    BOOLEAN

  Raw DMR model |
      {
          "operation-name" : "remove-message",
          "description" : "Remove the message corresponding to the given message-id.",
          "request-properties" : {"message-id" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "LONG"
              },
              "description" : "The message ID.",
              "expressions-allowed" : false,
              "required" : true,
              "nillable" : false,
              "stability" : "default"
          }},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "BOOLEAN"
              },
              "description" : "True if the message was removed, false otherwise."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- remove-messages - Remove messages matching the given filter from the queue.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  filter | STRING | false | true |  | A message filter. An undefined or empty filter will match all messages.

  ### Reply properties

  The number of removed messages.
  Type
    INT

  Raw DMR model |
      {
          "operation-name" : "remove-messages",
          "description" : "Remove messages matching the given filter from the queue.",
          "request-properties" : {"filter" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A message filter. An undefined or empty filter will match all messages.",
              "expressions-allowed" : true,
              "required" : false,
              "nillable" : true,
              "min-length" : 0,
              "max-length" : 2147483647,
              "stability" : "default"
          }},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "INT"
              },
              "description" : "The number of removed messages."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- reset-message-counter - Reset the message counters.

  Raw DMR model |
      {
          "operation-name" : "reset-message-counter",
          "description" : "Reset the message counters.",
          "request-properties" : {},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- resume - Resume the queue.

  Raw DMR model |
      {
          "operation-name" : "resume",
          "description" : "Resume the queue.",
          "request-properties" : {},
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- send-message-to-dead-letter-address - Send the message corresponding to the given message-id to this queue's Dead Letter Address.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  message-id | LONG | true | false |  | The message ID.

  ### Reply properties

  True if the message was sent to the dead letter address, false otherwise.
  Type
    BOOLEAN

  Raw DMR model |
      {
          "operation-name" : "send-message-to-dead-letter-address",
          "description" : "Send the message corresponding to the given message-id to this queue's Dead Letter Address.",
          "request-properties" : {"message-id" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "LONG"
              },
              "description" : "The message ID.",
              "expressions-allowed" : false,
              "required" : true,
              "nillable" : false,
              "stability" : "default"
          }},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "BOOLEAN"
              },
              "description" : "True if the message was sent to the dead letter address, false otherwise."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

- send-messages-to-dead-letter-address - Send the messages corresponding to the given filter to this queue's Dead Letter Address.

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  filter | STRING | false | true |  | A message filter. An undefined or empty filter will match all messages.

  ### Reply properties

  The number of sent messages.
  Type
    INT

  Raw DMR model |
      {
          "operation-name" : "send-messages-to-dead-letter-address",
          "description" : "Send the messages corresponding to the given filter to this queue's Dead Letter Address.",
          "request-properties" : {"filter" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "STRING"
              },
              "description" : "A message filter. An undefined or empty filter will match all messages.",
              "expressions-allowed" : true,
              "required" : false,
              "nillable" : true,
              "min-length" : 0,
              "max-length" : 2147483647,
              "stability" : "default"
          }},
          "reply-properties" : {
              "type" : {
                  "TYPE_MODEL_VALUE" : "INT"
              },
              "description" : "The number of sent messages."
          },
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : true
      }

## Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

- subsystem.messaging-activemq.server.queue

      <feature spec="subsystem.messaging-activemq.server.queue">
        <param name="queue" value="{resource name}"/>
        <param name="server" value="{resource name}"/>
        <param name="durable" value="{value}"/>
        <param name="filter" value="{value}"/>
        <param name="queue-address" value="{value}"/>
        <param name="routing-type" value="{value}"/>
      <feature/>