ExRabbitMQAdmin.TopicPermission (ex_rabbitmq_admin v0.3.0)

Copy Markdown View Source

This module contains functions for interacting with RabbitMQ topic permissions.

Summary

Functions

Delete topic permissions for a user on a specific vhost.

Get topic permissions for a user on a specific vhost.

Get a list of topic permissions for all users.

Set topic permissions for a user on a specific vhost.

Functions

delete_topic_permission(client, vhost, user)

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

Delete topic permissions for a user on a specific vhost.

get_topic_permission(client, vhost, user)

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

Get topic permissions for a user on a specific vhost.

list_topic_permissions(client)

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

Get a list of topic permissions for all users.

put_topic_permission(client, vhost, user, opts \\ [])

@spec put_topic_permission(
  client :: Tesla.Client.t(),
  vhost :: String.t(),
  user :: String.t(),
  opts :: Keyword.t()
) :: {:ok, Tesla.Env.t()} | no_return()

Set topic permissions for a user on a specific vhost.

Options

  • :exchange (String.t/0) - Required. The exchange or exchange pattern the topic permission applies to.

  • :write (String.t/0) - Required. A regular expression for write permission on topics. Defaults to deny-all. The default value is "^$".

  • :read (String.t/0) - Required. A regular expression for read permission on topics. Defaults to deny-all. The default value is "^$".