1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
// Copyright (C) 2023-2025 RabbitMQ Core Team (teamrabbitmq@gmail.com)
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use crate::{
path,
requests::{GlobalRuntimeParameterDefinition, RuntimeParameterDefinition},
responses,
};
use super::client::{Client, Result};
use std::fmt::Display;
impl<E, U, P> Client<E, U, P>
where
E: Display,
U: Display,
P: Display,
{
/// Lists all [runtime parameters](https://www.rabbitmq.com/docs/parameters) defined in the cluster.
///
/// Requires the `policymaker` user tag. Does not modify state.
pub fn list_runtime_parameters(&self) -> Result<Vec<responses::RuntimeParameter>> {
self.get_api_request("parameters")
}
/// Lists all [runtime parameters](https://www.rabbitmq.com/docs/parameters) with a given
/// component type (like "federation-upstream" or "shovel") defined in the cluster.
///
/// Requires the `policymaker` user tag. Does not modify state.
pub fn list_runtime_parameters_of_component(
&self,
component: &str,
) -> Result<Vec<responses::RuntimeParameter>> {
self.get_api_request(path!("parameters", component))
}
/// Lists all [runtime parameters](https://www.rabbitmq.com/docs/parameters) defined in
/// a specific virtual host.
///
/// Requires the `policymaker` user tag. Does not modify state.
pub fn list_runtime_parameters_of_component_in(
&self,
component: &str,
vhost: &str,
) -> Result<Vec<responses::RuntimeParameter>> {
self.get_api_request(path!("parameters", component, vhost))
}
/// Requires the `policymaker` user tag. Does not modify state.
pub fn get_runtime_parameter(
&self,
component: &str,
vhost: &str,
name: &str,
) -> Result<responses::RuntimeParameter> {
let response = self.http_get(path!("parameters", component, vhost, name), None, None)?;
let response = response.json()?;
Ok(response)
}
/// Requires the `policymaker` user tag.
pub fn upsert_runtime_parameter<'a>(
&self,
param: &'a RuntimeParameterDefinition<'a>,
) -> Result<()> {
let _response = self.http_put(
path!("parameters", param.component, param.vhost, param.name),
¶m,
None,
None,
)?;
Ok(())
}
/// Requires the `policymaker` user tag.
pub fn clear_runtime_parameter(
&self,
component: &str,
vhost: &str,
name: &str,
idempotently: bool,
) -> Result<()> {
self.delete_api_request_with_optional_not_found(
path!("parameters", component, vhost, name),
idempotently,
)
}
/// Requires the `policymaker` user tag.
pub fn clear_all_runtime_parameters(&self) -> Result<()> {
let params = self.list_runtime_parameters()?;
for rp in params {
self.clear_runtime_parameter(&rp.component, &rp.vhost, &rp.name, false)?
}
Ok(())
}
/// Requires the `policymaker` user tag.
pub fn clear_all_runtime_parameters_of_component(&self, component: &str) -> Result<()> {
let params = self.list_runtime_parameters_of_component(component)?;
for rp in params {
self.clear_runtime_parameter(&rp.component, &rp.vhost, &rp.name, false)?
}
Ok(())
}
/// Requires the `policymaker` user tag. Does not modify state.
pub fn list_global_runtime_parameters(&self) -> Result<Vec<responses::GlobalRuntimeParameter>> {
let response = self.http_get("global-parameters", None, None)?;
let response = response.json()?;
Ok(response)
}
/// Requires the `policymaker` user tag. Does not modify state.
pub fn get_global_runtime_parameter(
&self,
name: &str,
) -> Result<responses::GlobalRuntimeParameter> {
let response = self.http_get(path!("global-parameters", name), None, None)?;
let response = response.json()?;
Ok(response)
}
/// Requires the `administrator` user tag.
pub fn upsert_global_runtime_parameter<'a>(
&self,
param: &'a GlobalRuntimeParameterDefinition<'a>,
) -> Result<()> {
let _response =
self.http_put(path!("global-parameters", param.name), ¶m, None, None)?;
Ok(())
}
/// Requires the `administrator` user tag.
pub fn clear_global_runtime_parameter(&self, name: &str) -> Result<()> {
let _response = self.http_delete(path!("global-parameters", name), None, None)?;
Ok(())
}
}