google_cloud_parametermanager_v1/client.rs
1// Copyright 2025 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// https://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14//
15// Code generated by sidekick. DO NOT EDIT.
16#![allow(rustdoc::redundant_explicit_links)]
17#![allow(rustdoc::broken_intra_doc_links)]
18
19/// Implements a client for the Parameter Manager API.
20///
21/// # Example
22/// ```
23/// # use google_cloud_parametermanager_v1::client::ParameterManager;
24/// use google_cloud_gax::paginator::ItemPaginator as _;
25/// # async fn sample() -> Result<(), Box<dyn std::error::Error>> {
26/// let client = ParameterManager::builder().build().await?;
27/// let parent = "parent_value";
28/// let mut list = client.list_parameters()
29/// .set_parent(parent)
30/// .by_item();
31/// while let Some(item) = list.next().await.transpose()? {
32/// println!("{:?}", item);
33/// }
34/// # Ok(()) }
35/// ```
36///
37/// # Service Description
38///
39/// Service describing handlers for resources
40///
41/// # Configuration
42///
43/// To configure `ParameterManager` use the `with_*` methods in the type returned
44/// by [builder()][ParameterManager::builder]. The default configuration should
45/// work for most applications. Common configuration changes include
46///
47/// * [with_endpoint()]: by default this client uses the global default endpoint
48/// (`https://parametermanager.googleapis.com`). Applications using regional
49/// endpoints or running in restricted networks (e.g. a network configured
50// with [Private Google Access with VPC Service Controls]) may want to
51/// override this default.
52/// * [with_credentials()]: by default this client uses
53/// [Application Default Credentials]. Applications using custom
54/// authentication may need to override this default.
55///
56/// [with_endpoint()]: super::builder::parameter_manager::ClientBuilder::with_endpoint
57/// [with_credentials()]: super::builder::parameter_manager::ClientBuilder::with_credentials
58/// [Private Google Access with VPC Service Controls]: https://cloud.google.com/vpc-service-controls/docs/private-connectivity
59/// [Application Default Credentials]: https://cloud.google.com/docs/authentication#adc
60///
61/// # Pooling and Cloning
62///
63/// `ParameterManager` holds a connection pool internally, it is advised to
64/// create one and reuse it. You do not need to wrap `ParameterManager` in
65/// an [Rc](std::rc::Rc) or [Arc](std::sync::Arc) to reuse it, because it
66/// already uses an `Arc` internally.
67#[derive(Clone, Debug)]
68pub struct ParameterManager {
69 inner: std::sync::Arc<dyn super::stub::dynamic::ParameterManager>,
70}
71
72impl ParameterManager {
73 /// Returns a builder for [ParameterManager].
74 ///
75 /// ```
76 /// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
77 /// # use google_cloud_parametermanager_v1::client::ParameterManager;
78 /// let client = ParameterManager::builder().build().await?;
79 /// # Ok(()) }
80 /// ```
81 pub fn builder() -> super::builder::parameter_manager::ClientBuilder {
82 crate::new_client_builder(super::builder::parameter_manager::client::Factory)
83 }
84
85 /// Creates a new client from the provided stub.
86 ///
87 /// The most common case for calling this function is in tests mocking the
88 /// client's behavior.
89 pub fn from_stub<T>(stub: T) -> Self
90 where
91 T: super::stub::ParameterManager + 'static,
92 {
93 Self {
94 inner: std::sync::Arc::new(stub),
95 }
96 }
97
98 pub(crate) async fn new(
99 config: gaxi::options::ClientConfig,
100 ) -> crate::ClientBuilderResult<Self> {
101 let inner = Self::build_inner(config).await?;
102 Ok(Self { inner })
103 }
104
105 async fn build_inner(
106 conf: gaxi::options::ClientConfig,
107 ) -> crate::ClientBuilderResult<std::sync::Arc<dyn super::stub::dynamic::ParameterManager>>
108 {
109 if gaxi::options::tracing_enabled(&conf) {
110 return Ok(std::sync::Arc::new(Self::build_with_tracing(conf).await?));
111 }
112 Ok(std::sync::Arc::new(Self::build_transport(conf).await?))
113 }
114
115 async fn build_transport(
116 conf: gaxi::options::ClientConfig,
117 ) -> crate::ClientBuilderResult<impl super::stub::ParameterManager> {
118 super::transport::ParameterManager::new(conf).await
119 }
120
121 async fn build_with_tracing(
122 conf: gaxi::options::ClientConfig,
123 ) -> crate::ClientBuilderResult<impl super::stub::ParameterManager> {
124 Self::build_transport(conf)
125 .await
126 .map(super::tracing::ParameterManager::new)
127 }
128
129 /// Lists Parameters in a given project and location.
130 ///
131 /// # Example
132 /// ```
133 /// # use google_cloud_parametermanager_v1::client::ParameterManager;
134 /// use google_cloud_gax::paginator::ItemPaginator as _;
135 /// use google_cloud_parametermanager_v1::Result;
136 /// async fn sample(
137 /// client: &ParameterManager, parent: &str
138 /// ) -> Result<()> {
139 /// let mut list = client.list_parameters()
140 /// .set_parent(parent)
141 /// .by_item();
142 /// while let Some(item) = list.next().await.transpose()? {
143 /// println!("{:?}", item);
144 /// }
145 /// Ok(())
146 /// }
147 /// ```
148 pub fn list_parameters(&self) -> super::builder::parameter_manager::ListParameters {
149 super::builder::parameter_manager::ListParameters::new(self.inner.clone())
150 }
151
152 /// Gets details of a single Parameter.
153 ///
154 /// # Example
155 /// ```
156 /// # use google_cloud_parametermanager_v1::client::ParameterManager;
157 /// use google_cloud_parametermanager_v1::Result;
158 /// async fn sample(
159 /// client: &ParameterManager, name: &str
160 /// ) -> Result<()> {
161 /// let response = client.get_parameter()
162 /// .set_name(name)
163 /// .send().await?;
164 /// println!("response {:?}", response);
165 /// Ok(())
166 /// }
167 /// ```
168 pub fn get_parameter(&self) -> super::builder::parameter_manager::GetParameter {
169 super::builder::parameter_manager::GetParameter::new(self.inner.clone())
170 }
171
172 /// Creates a new Parameter in a given project and location.
173 ///
174 /// # Example
175 /// ```
176 /// # use google_cloud_parametermanager_v1::client::ParameterManager;
177 /// use google_cloud_parametermanager_v1::model::Parameter;
178 /// use google_cloud_parametermanager_v1::Result;
179 /// async fn sample(
180 /// client: &ParameterManager, parent: &str
181 /// ) -> Result<()> {
182 /// let response = client.create_parameter()
183 /// .set_parent(parent)
184 /// .set_parameter_id("parameter_id_value")
185 /// .set_parameter(
186 /// Parameter::new()/* set fields */
187 /// )
188 /// .send().await?;
189 /// println!("response {:?}", response);
190 /// Ok(())
191 /// }
192 /// ```
193 pub fn create_parameter(&self) -> super::builder::parameter_manager::CreateParameter {
194 super::builder::parameter_manager::CreateParameter::new(self.inner.clone())
195 }
196
197 /// Updates a single Parameter.
198 ///
199 /// # Example
200 /// ```
201 /// # use google_cloud_parametermanager_v1::client::ParameterManager;
202 /// # extern crate wkt as google_cloud_wkt;
203 /// use google_cloud_wkt::FieldMask;
204 /// use google_cloud_parametermanager_v1::model::Parameter;
205 /// use google_cloud_parametermanager_v1::Result;
206 /// async fn sample(
207 /// client: &ParameterManager, name: &str
208 /// ) -> Result<()> {
209 /// let response = client.update_parameter()
210 /// .set_parameter(
211 /// Parameter::new().set_name(name)/* set fields */
212 /// )
213 /// .set_update_mask(FieldMask::default().set_paths(["updated.field.path1", "updated.field.path2"]))
214 /// .send().await?;
215 /// println!("response {:?}", response);
216 /// Ok(())
217 /// }
218 /// ```
219 pub fn update_parameter(&self) -> super::builder::parameter_manager::UpdateParameter {
220 super::builder::parameter_manager::UpdateParameter::new(self.inner.clone())
221 }
222
223 /// Deletes a single Parameter.
224 ///
225 /// # Example
226 /// ```
227 /// # use google_cloud_parametermanager_v1::client::ParameterManager;
228 /// use google_cloud_parametermanager_v1::Result;
229 /// async fn sample(
230 /// client: &ParameterManager, name: &str
231 /// ) -> Result<()> {
232 /// client.delete_parameter()
233 /// .set_name(name)
234 /// .send().await?;
235 /// Ok(())
236 /// }
237 /// ```
238 pub fn delete_parameter(&self) -> super::builder::parameter_manager::DeleteParameter {
239 super::builder::parameter_manager::DeleteParameter::new(self.inner.clone())
240 }
241
242 /// Lists ParameterVersions in a given project, location, and parameter.
243 ///
244 /// # Example
245 /// ```
246 /// # use google_cloud_parametermanager_v1::client::ParameterManager;
247 /// use google_cloud_gax::paginator::ItemPaginator as _;
248 /// use google_cloud_parametermanager_v1::Result;
249 /// async fn sample(
250 /// client: &ParameterManager, parent: &str
251 /// ) -> Result<()> {
252 /// let mut list = client.list_parameter_versions()
253 /// .set_parent(parent)
254 /// .by_item();
255 /// while let Some(item) = list.next().await.transpose()? {
256 /// println!("{:?}", item);
257 /// }
258 /// Ok(())
259 /// }
260 /// ```
261 pub fn list_parameter_versions(
262 &self,
263 ) -> super::builder::parameter_manager::ListParameterVersions {
264 super::builder::parameter_manager::ListParameterVersions::new(self.inner.clone())
265 }
266
267 /// Gets details of a single ParameterVersion.
268 ///
269 /// # Example
270 /// ```
271 /// # use google_cloud_parametermanager_v1::client::ParameterManager;
272 /// use google_cloud_parametermanager_v1::Result;
273 /// async fn sample(
274 /// client: &ParameterManager, name: &str
275 /// ) -> Result<()> {
276 /// let response = client.get_parameter_version()
277 /// .set_name(name)
278 /// .send().await?;
279 /// println!("response {:?}", response);
280 /// Ok(())
281 /// }
282 /// ```
283 pub fn get_parameter_version(&self) -> super::builder::parameter_manager::GetParameterVersion {
284 super::builder::parameter_manager::GetParameterVersion::new(self.inner.clone())
285 }
286
287 /// Gets rendered version of a ParameterVersion.
288 ///
289 /// # Example
290 /// ```
291 /// # use google_cloud_parametermanager_v1::client::ParameterManager;
292 /// use google_cloud_parametermanager_v1::Result;
293 /// async fn sample(
294 /// client: &ParameterManager
295 /// ) -> Result<()> {
296 /// let response = client.render_parameter_version()
297 /// /* set fields */
298 /// .send().await?;
299 /// println!("response {:?}", response);
300 /// Ok(())
301 /// }
302 /// ```
303 pub fn render_parameter_version(
304 &self,
305 ) -> super::builder::parameter_manager::RenderParameterVersion {
306 super::builder::parameter_manager::RenderParameterVersion::new(self.inner.clone())
307 }
308
309 /// Creates a new ParameterVersion in a given project, location, and parameter.
310 ///
311 /// # Example
312 /// ```
313 /// # use google_cloud_parametermanager_v1::client::ParameterManager;
314 /// use google_cloud_parametermanager_v1::model::ParameterVersion;
315 /// use google_cloud_parametermanager_v1::Result;
316 /// async fn sample(
317 /// client: &ParameterManager, parent: &str
318 /// ) -> Result<()> {
319 /// let response = client.create_parameter_version()
320 /// .set_parent(parent)
321 /// .set_parameter_version(
322 /// ParameterVersion::new()/* set fields */
323 /// )
324 /// .send().await?;
325 /// println!("response {:?}", response);
326 /// Ok(())
327 /// }
328 /// ```
329 pub fn create_parameter_version(
330 &self,
331 ) -> super::builder::parameter_manager::CreateParameterVersion {
332 super::builder::parameter_manager::CreateParameterVersion::new(self.inner.clone())
333 }
334
335 /// Updates a single ParameterVersion.
336 ///
337 /// # Example
338 /// ```
339 /// # use google_cloud_parametermanager_v1::client::ParameterManager;
340 /// # extern crate wkt as google_cloud_wkt;
341 /// use google_cloud_wkt::FieldMask;
342 /// use google_cloud_parametermanager_v1::model::ParameterVersion;
343 /// use google_cloud_parametermanager_v1::Result;
344 /// async fn sample(
345 /// client: &ParameterManager, name: &str
346 /// ) -> Result<()> {
347 /// let response = client.update_parameter_version()
348 /// .set_parameter_version(
349 /// ParameterVersion::new().set_name(name)/* set fields */
350 /// )
351 /// .set_update_mask(FieldMask::default().set_paths(["updated.field.path1", "updated.field.path2"]))
352 /// .send().await?;
353 /// println!("response {:?}", response);
354 /// Ok(())
355 /// }
356 /// ```
357 pub fn update_parameter_version(
358 &self,
359 ) -> super::builder::parameter_manager::UpdateParameterVersion {
360 super::builder::parameter_manager::UpdateParameterVersion::new(self.inner.clone())
361 }
362
363 /// Deletes a single ParameterVersion.
364 ///
365 /// # Example
366 /// ```
367 /// # use google_cloud_parametermanager_v1::client::ParameterManager;
368 /// use google_cloud_parametermanager_v1::Result;
369 /// async fn sample(
370 /// client: &ParameterManager, name: &str
371 /// ) -> Result<()> {
372 /// client.delete_parameter_version()
373 /// .set_name(name)
374 /// .send().await?;
375 /// Ok(())
376 /// }
377 /// ```
378 pub fn delete_parameter_version(
379 &self,
380 ) -> super::builder::parameter_manager::DeleteParameterVersion {
381 super::builder::parameter_manager::DeleteParameterVersion::new(self.inner.clone())
382 }
383
384 /// Lists information about the supported locations for this service.
385 ///
386 /// # Example
387 /// ```
388 /// # use google_cloud_parametermanager_v1::client::ParameterManager;
389 /// use google_cloud_gax::paginator::ItemPaginator as _;
390 /// use google_cloud_parametermanager_v1::Result;
391 /// async fn sample(
392 /// client: &ParameterManager
393 /// ) -> Result<()> {
394 /// let mut list = client.list_locations()
395 /// /* set fields */
396 /// .by_item();
397 /// while let Some(item) = list.next().await.transpose()? {
398 /// println!("{:?}", item);
399 /// }
400 /// Ok(())
401 /// }
402 /// ```
403 pub fn list_locations(&self) -> super::builder::parameter_manager::ListLocations {
404 super::builder::parameter_manager::ListLocations::new(self.inner.clone())
405 }
406
407 /// Gets information about a location.
408 ///
409 /// # Example
410 /// ```
411 /// # use google_cloud_parametermanager_v1::client::ParameterManager;
412 /// use google_cloud_parametermanager_v1::Result;
413 /// async fn sample(
414 /// client: &ParameterManager
415 /// ) -> Result<()> {
416 /// let response = client.get_location()
417 /// /* set fields */
418 /// .send().await?;
419 /// println!("response {:?}", response);
420 /// Ok(())
421 /// }
422 /// ```
423 pub fn get_location(&self) -> super::builder::parameter_manager::GetLocation {
424 super::builder::parameter_manager::GetLocation::new(self.inner.clone())
425 }
426}