ExRabbitMQAdmin.Definition (ex_rabbitmq_admin v0.3.0)

Copy Markdown View Source

Functions for interacting with RabbitMQ server and virtual host definitions.

Summary

Functions

list_definitions(client)

List all server definitions - exchanges, queues, bindings, users, virtual hosts, permissions, topic permissions, and parameters.

list_vhost_definitions(client, vhost)

List all definitions for a specific virtual host.

upload_definitions(client, definitions)

Upload and merge server definitions. Existing definitions will be merged with the uploaded ones.

upload_vhost_definitions(client, vhost, definitions)

Upload definitions for a specific virtual host.

Functions

list_definitions(client)

@spec list_definitions(client :: Tesla.Client.t()) ::
  {:ok, Tesla.Env.t()} | {:error, term()}

List all server definitions - exchanges, queues, bindings, users, virtual hosts, permissions, topic permissions, and parameters.

list_vhost_definitions(client, vhost)

@spec list_vhost_definitions(client :: Tesla.Client.t(), vhost :: String.t()) ::
  {:ok, Tesla.Env.t()} | {:error, term()}

List all definitions for a specific virtual host.

upload_definitions(client, definitions)

@spec upload_definitions(client :: Tesla.Client.t(), definitions :: map()) ::
  {:ok, Tesla.Env.t()} | {:error, term()}

Upload and merge server definitions. Existing definitions will be merged with the uploaded ones.

upload_vhost_definitions(client, vhost, definitions)

@spec upload_vhost_definitions(
  client :: Tesla.Client.t(),
  vhost :: String.t(),
  definitions :: map()
) :: {:ok, Tesla.Env.t()} | {:error, term()}

Upload definitions for a specific virtual host.