Queue

analyze.queue.add_message(vhost_id, queue_id)

Adds a message to the queue

Parameters
  • vhost_id (str) – Unique virtual host name

  • queue_id (str) – Unique queue name

Returns

None

analyze.queue.bindings()

Provides a list of bindings

Returns

list of bindings

Return type

list

analyze.queue.connections(vhost_id, queue_id)

Provides list of connections to the queue

Parameters
  • vhost_id (str) – Unique virtual host Name

  • queue_id (str) – Unique queue name

Returns

None

analyze.queue.create(vhost_id, name, durable)

Creates a queue within an existing vhost

Parameters
  • vhost_id (str) – Unique virtual host name

  • name (str) – Unique queue name

  • durable (bool) – If True, the queue will be durable

Returns

None

analyze.queue.create_binding(name, properties_key, routing_key, destination_type)

Creates a binding

Parameters
  • name (str) – The object name

  • properties_key (str) – Properties key

  • routing_key (str) – Routing key

  • destination_type (str) – Destination type

Returns

None

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

Parameters
  • name (str) – Virtual host name

  • binding_ids (list) – Unique binding identifiers

  • exchange_ids (list) – Unique exchange identifiers

Returns

None

analyze.queue.delete(vhost_id, queue_id)

Deletes a queue from a vhost

Parameters
  • vhost_id (str) – Unique virtual host name

  • queue_id (str) – Unique queue name

Returns

None

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.exchanges()

Provides a list of exchanges

Returns

list of exchanges

Return type

list

analyze.queue.messages(vhost_id, queue_id)

Provides a list of messages in the queue. This may change the order.

Parameters
  • vhost_id (str) – Unique virtual host name

  • queue_id (str) – Unique queue name

Returns

None

analyze.queue.purge(vhost_id, queue_id)

Purges the queue of messages

Parameters
  • vhost_id (str) – Unique virtual host name

  • queue_id (str) – Unique queue name

Returns

None

analyze.queue.queue(vhost_id, queue_id)

Provides detailed queue information

Parameters
  • vhost_id (str) – Unique virtual host Name

  • queue_id (str) – Unique queue name

Returns

None

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

Parameters
  • vhost_id (str) – Unique virtual host name

  • text (str) – The search text to locate

  • criteria (str) – The search criteria (contains, exact, startswith, or endswith)

Returns

None

analyze.queue.search_binding(text, criteria='contains')

Searchs for specific bindings

Parameters
  • text (str) – The search text to locate

  • criteria (str) – The search criteria (contains, exact, startswith, or endswith)

Returns

None

analyze.queue.search_exchange(text, criteria='contains')

Searches for specific exchanges

Parameters
  • text (str) – The search text to locate

  • criteria (str) – The search criteria (contains, exact, startswith, or endswith)

Returns

None

analyze.queue.search_user(text, criteria='contains')

Searches for specific users

Parameters
  • text (str) – The search text to locate

  • criteria (str) – The search criteria (contains, exact, startswith, or endswith)

Returns

None

analyze.queue.search_vhost(text, criteria='contains')

Searches for specific vhosts

Parameters
  • text (str) – The search text to locate

  • criteria (str) – The search criteria (contains, exact, startswith, or endswith)

Returns

None

analyze.queue.user(user_id)

Provides detailed access user information

Parameters

user_id (str) – Unique user identifier

Returns

None

analyze.queue.users()

Provides a list of access users

Returns

List of users

Return type

list

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

Parameters
  • vhost_id (str) – Unique virtual host name

  • user_permissions (list) – list of user permissions

Returns

None

analyze.queue.vhosts()

Provides a list of vhosts

Returns

list of vhosts

Return type

list