Defines a Jakarta Messaging topic.
Attribute | Value |
---|---|
Type | INT |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | metric |
Attribute | Value |
---|---|
Type | INT |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | metric |
Attribute | Value |
---|---|
Type | INT |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | metric |
Attribute | Value |
---|---|
Type | LIST |
Nillable | false |
Expressions Allowed | true |
Storage | runtime |
Access Type | read-only |
Attribute | Value |
---|---|
Type | LIST |
Nillable | true |
Expressions Allowed | true |
Storage | runtime |
Access Type | read-only |
Attribute | Value |
---|---|
Type | LONG |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | metric |
Attribute | Value |
---|---|
Type | LONG |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | metric |
Attribute | Value |
---|---|
Type | INT |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | metric |
Attribute | Value |
---|---|
Type | INT |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | metric |
Attribute | Value |
---|---|
Type | BOOLEAN |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | read-only |
Attribute | Value |
---|---|
Type | INT |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | metric |
Attribute | Value |
---|---|
Type | BOOLEAN |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | read-only |
Attribute | Value |
---|---|
Type | STRING |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | read-only |
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
client-id | STRING | true | true | The client ID. | |
subscription-name | STRING | true | false | The name of the durable subscription. | |
filter | STRING | false | true | =A message filter. An undefined or empty filter will match all messages. |
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
client-id | STRING | true | true | The client ID. | |
subscription-name | STRING | true | false | The name of the durable subscription. |
{
"queueName" => {
"type" => STRING,
"description" => "The full name of the queue.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"clientID" => {
"type" => STRING,
"description" => "The client id.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"selector" => {
"type" => STRING,
"description" => "The queue selector.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"name" => {
"type" => STRING,
"description" => "The name of the queue.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"durable" => {
"type" => BOOLEAN,
"description" => "Whether the queue is durable or not.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"messageCount" => {
"type" => LONG,
"description" => "The number of messages currently in this queue.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"deliveringCount" => {
"type" => INT,
"description" => "The number of messages that this queue is currently delivering to its consumers.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"consumers" => {
"type" => LIST,
"description" => "The queue consumers.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 0L,
"max-length" => 2147483647L,
"value-type" => {
"consumerID" => {
"type" => STRING,
"description" => "The consumer ID.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"connectionID" => {
"type" => STRING,
"description" => "The connection id.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"sessionID" => {
"type" => STRING,
"description" => "The consumer's session id.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"browseOnly" => {
"type" => BOOLEAN,
"description" => "Whether the consumer is only browsing the queue.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"creationTime" => {
"type" => BOOLEAN,
"description" => "Time when the consumer was created, in ms since the epoch.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
}
}
}
}
{
"queueName" => {
"type" => STRING,
"description" => "The full name of the queue.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"clientID" => {
"type" => STRING,
"description" => "The client id.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"selector" => {
"type" => STRING,
"description" => "The queue selector.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"name" => {
"type" => STRING,
"description" => "The name of the queue.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"durable" => {
"type" => BOOLEAN,
"description" => "Whether the queue is durable or not.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"messageCount" => {
"type" => LONG,
"description" => "The number of messages currently in this queue.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"deliveringCount" => {
"type" => INT,
"description" => "The number of messages that this queue is currently delivering to its consumers.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"consumers" => {
"type" => LIST,
"description" => "The queue consumers.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 0L,
"max-length" => 2147483647L,
"value-type" => {
"consumerID" => {
"type" => STRING,
"description" => "The consumer ID.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"connectionID" => {
"type" => STRING,
"description" => "The connection id.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"sessionID" => {
"type" => STRING,
"description" => "The consumer's session id.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"browseOnly" => {
"type" => BOOLEAN,
"description" => "Whether the consumer is only browsing the queue.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"creationTime" => {
"type" => BOOLEAN,
"description" => "Time when the consumer was created, in ms since the epoch.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
}
}
}
}
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
queue-name | STRING | true | false | The name of the queue representing a subscription |
{
"JMSMessageID" => {
"type" => STRING,
"description" => "The message ID.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"JMSPriority" => {
"type" => INT,
"description" => "The message's priority.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min" => 0L,
"max" => 9L
},
"JMSTimestamp" => {
"type" => LONG,
"description" => "The message's timestamp, in ms since the epoch.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"JMSExpiration" => {
"type" => LONG,
"description" => "The message's expiration time.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"JMSDeliveryMode" => {
"type" => STRING,
"description" => "The delivery mode for the message, PERSISTENT or NON_PERSISTENT.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L,
"allowed" => [
"PERSISTENT",
"NON_PERSISTENT"
]
}
}
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
queue-name | STRING | true | false | The name of the queue representing a subscription |
{
"queueName" => {
"type" => STRING,
"description" => "The full name of the queue.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"clientID" => {
"type" => STRING,
"description" => "The client id.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"selector" => {
"type" => STRING,
"description" => "The queue selector.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"name" => {
"type" => STRING,
"description" => "The name of the queue.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"durable" => {
"type" => BOOLEAN,
"description" => "Whether the queue is durable or not.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"messageCount" => {
"type" => LONG,
"description" => "The number of messages currently in this queue.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"deliveringCount" => {
"type" => INT,
"description" => "The number of messages that this queue is currently delivering to its consumers.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"consumers" => {
"type" => LIST,
"description" => "The queue consumers.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 0L,
"max-length" => 2147483647L,
"value-type" => {
"consumerID" => {
"type" => STRING,
"description" => "The consumer ID.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"connectionID" => {
"type" => STRING,
"description" => "The connection id.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"sessionID" => {
"type" => STRING,
"description" => "The consumer's session id.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"browseOnly" => {
"type" => BOOLEAN,
"description" => "Whether the consumer is only browsing the queue.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
},
"creationTime" => {
"type" => BOOLEAN,
"description" => "Time when the consumer was created, in ms since the epoch.",
"expressions-allowed" => false,
"required" => true,
"nillable" => false
}
}
}
}
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
persist | BOOLEAN | false | false | false | Persist the paused status of this Topic. |
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. |