ExRabbitMQAdmin.Parameter (ex_rabbitmq_admin v0.3.0)

Copy Markdown View Source

This module contains functions for interacting with RabbitMQ vhost-scoped parameters.

Summary

Functions

delete_parameter(client, component, vhost, name)

Delete a specific vhost-scoped parameter.

get_parameter(client, component, vhost, name)

Get a specific vhost-scoped parameter.

list_component_parameters(client, component)

Get a list of all vhost-scoped parameters for a given component.

list_component_vhost_parameters(client, component, vhost)

Get a list of all vhost-scoped parameters for a given component on a specific vhost.

list_parameters(client)

Get a list of all vhost-scoped parameters.

put_parameter(client, component, vhost, name, value)

Set a specific vhost-scoped parameter.

Functions

delete_parameter(client, component, vhost, name)

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

Delete a specific vhost-scoped parameter.

get_parameter(client, component, vhost, name)

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

Get a specific vhost-scoped parameter.

list_component_parameters(client, component)

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

Get a list of all vhost-scoped parameters for a given component.

list_component_vhost_parameters(client, component, vhost)

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

Get a list of all vhost-scoped parameters for a given component on a specific vhost.

list_parameters(client)

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

Get a list of all vhost-scoped parameters.

put_parameter(client, component, vhost, name, value)

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

Set a specific vhost-scoped parameter.