Queue¶
-
analyze.queue.
add_message
(vhost_id, queue_id)¶ Adds a message to the queue
-
analyze.queue.
connections
(vhost_id, queue_id)¶ Provides list of connections to the queue
-
analyze.queue.
create
(vhost_id, name, durable)¶ Creates a queue within an existing vhost
-
analyze.queue.
create_binding
(name, properties_key, routing_key, destination_type)¶ Creates a binding
-
analyze.queue.
create_user
(name)¶ Creates an access user
- Parameters
name (str) – Unique user name
- Returns
None
-
analyze.queue.
create_vhost
(name, binding_ids, exchange_ids)¶ Creates a vhost
-
analyze.queue.
delete
(vhost_id, queue_id)¶ Deletes a queue from a vhost
-
analyze.queue.
delete_binding
(binding_id)¶ Deletes a binding
- Parameters
binding_id (str) – Unique binding identifier
- Returns
None
-
analyze.queue.
delete_exchange
(exchange_id)¶ Deletes an exchange
- Parameters
exchange_id (str) – Unique exchange identifier
- Returns
None
-
analyze.queue.
delete_user
(user_id)¶ Deletes an access user
- Parameters
user_id (str) – Unique user identifier
- Returns
None
-
analyze.queue.
delete_vhost
(vhost_id)¶ Deletes a vhost and associated relationships including queues, bindings, permissions, and exchanges
- Parameters
vhost_id (str) – Unique virtual host name
- Returns
None
-
analyze.queue.
messages
(vhost_id, queue_id)¶ Provides a list of messages in the queue. This may change the order.
-
analyze.queue.
purge
(vhost_id, queue_id)¶ Purges the queue of messages
-
analyze.queue.
queue
(vhost_id, queue_id)¶ Provides detailed queue information
-
analyze.queue.
queues
(vhost_id)¶ Provides a list of queues in the vhost
- Parameters
vhost_id (str) – Unique virtual host name
- Returns
None
-
analyze.queue.
search
(vhost_id, text, criteria='contains')¶ Searches for specific queues
-
analyze.queue.
search_binding
(text, criteria='contains')¶ Searchs for specific bindings
-
analyze.queue.
search_exchange
(text, criteria='contains')¶ Searches for specific exchanges
-
analyze.queue.
search_user
(text, criteria='contains')¶ Searches for specific users
-
analyze.queue.
search_vhost
(text, criteria='contains')¶ Searches for specific vhosts
-
analyze.queue.
user
(user_id)¶ Provides detailed access user information
- Parameters
user_id (str) – Unique user identifier
- Returns
None
-
analyze.queue.
vhost
(vhost_id)¶ Provides detailed vhost information
- Parameters
vhost_id (str) – Unique virtual host name
- Returns
None
-
analyze.queue.
vhost_add_users
(vhost_id, user_permissions)¶ Adds list of access users to a vhost