HawkListener:getQueues
Method
Purpose
This method (on all platforms) gets information on queues on this server.
Remarks
The queueRegExp
argument is a pattern match using regular expressions. Test any regular expressions you plan to use in rulebases by first using them interactively to ensure they return the desired results.The cursorInitialPosition and cursorSize arguments allows to return only a set number of queues instead of all queues.
Type
Synchronous, IMPACT_INFO
Arguments
Name |
Type |
Description |
queueRegExp |
String |
Queue Name. Empty argument string provides information on all queues. |
queueType |
String |
Queue type. Empty argument string provides information on all topics. |
cursorInitialPosition |
Integer |
Initial position of the cursor. |
cursorSize |
Integer |
Size of the cursor to determine the number of queues to return. |
Returns
Name |
Type |
Description |
name |
String |
Name of this queue |
description |
String |
Description of this queue |
pendingMessageSize |
Long |
The value indicating the total size for all pending messages for this queue |
pendingMessageSizeUsage |
Double |
The value indicating the total size as a fraction of maxBytes for this queue |
pendingMessageCount |
Long |
The value indicating the total number of pending messages for this queue |
pendingMessageCountUsage |
Double |
The value indicating the total number of pending messages as a fraction of maxMsgs for this queue |
inTransitCount |
Long |
The value indicating the number of messages in transit to client |
deliveredMessageCount |
Long |
The value indicating the number of messages delivered to client |
consumerCount |
Integer |
Number of consumers for this queue |
receiverCount |
Integer |
Number of active receivers on this queue |
exclusive |
Boolean |
The flag passed to indicate whether the queue is exclusive |
expiryOverride |
Long |
The value indicating the expiry override property |
failsafe |
Boolean |
The flag passed to indicate whether the queue is failsafe |
flowControl |
Long |
target max size of pending messages in bytes before flow control starts |
global |
Boolean |
The flag passed to indicate whether the queue is global |
hasSenderName |
Boolean |
The flag passed to indicate whether the sender_name property is set |
maxBytes |
Long |
The value indicating the maximum number of message bytes that the server stores for pending messages bound for this queue. |
maxMsgs |
Long |
The value indicating the maximum number of messages that the server stores for pending messages bound for this queue. |
maxRedelivery |
Integer |
Maximum number of redelivery attempts |
overflowPolicy |
String |
Overflow policy for this queue |
prefetch |
Integer |
Number of messages prefetched by the client |
routeConnected |
Boolean |
The flag passed to indicate whether the route for this queue is connected |
routed |
Boolean |
The flag passed to indicate whether this is a routed queue |
routeName |
String |
The name of the route for this routed queue |
secure |
Boolean |
The flag passed to indicate whether the queue is secure |
senderNameEnforced |
Boolean |
The flag passed to indicate whether sender_name_enforced property is set |
static |
Boolean |
The flag passed to indicate whether the queue is static |
temporary |
Boolean |
The flag passed to indicate whether the queue is temporary |
outboundByteRate |
Long |
The value indicating the outbound bytes per second |
outboundMessageRate |
Long |
The value indicating the outbound messages per second |
outboundTotalBytes |
Long |
The value indicating the outbound total bytes |
outboundTotalMessages |
Long |
The value indicating the outbound total messages |
inboundByteRate |
Long |
The value indicating the inbound bytes per second |
inboundMessageRate |
Long |
The value indicating the inbound messages per second |
inboundTotalBytes |
Long |
The value indicating the inbound total bytes |
Long |
The value indicating the inbound total messages |