google_cloud_maintenance_api_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 Maintenance API.
20///
21/// # Example
22/// ```
23/// # tokio_test::block_on(async {
24/// # use google_cloud_maintenance_api_v1::client::Maintenance;
25/// let client = Maintenance::builder().build().await?;
26/// // use `client` to make requests to the Maintenance API.
27/// # gax::client_builder::Result::<()>::Ok(()) });
28/// ```
29///
30/// # Service Description
31///
32/// Unified Maintenance service
33///
34/// # Configuration
35///
36/// To configure `Maintenance` use the `with_*` methods in the type returned
37/// by [builder()][Maintenance::builder]. The default configuration should
38/// work for most applications. Common configuration changes include
39///
40/// * [with_endpoint()]: by default this client uses the global default endpoint
41///   (`https://maintenance.googleapis.com`). Applications using regional
42///   endpoints or running in restricted networks (e.g. a network configured
43//    with [Private Google Access with VPC Service Controls]) may want to
44///   override this default.
45/// * [with_credentials()]: by default this client uses
46///   [Application Default Credentials]. Applications using custom
47///   authentication may need to override this default.
48///
49/// [with_endpoint()]: super::builder::maintenance::ClientBuilder::with_endpoint
50/// [with_credentials()]: super::builder::maintenance::ClientBuilder::credentials
51/// [Private Google Access with VPC Service Controls]: https://cloud.google.com/vpc-service-controls/docs/private-connectivity
52/// [Application Default Credentials]: https://cloud.google.com/docs/authentication#adc
53///
54/// # Pooling and Cloning
55///
56/// `Maintenance` holds a connection pool internally, it is advised to
57/// create one and the reuse it.  You do not need to wrap `Maintenance` in
58/// an [Rc](std::rc::Rc) or [Arc](std::sync::Arc) to reuse it, because it
59/// already uses an `Arc` internally.
60#[derive(Clone, Debug)]
61pub struct Maintenance {
62    inner: std::sync::Arc<dyn super::stub::dynamic::Maintenance>,
63}
64
65impl Maintenance {
66    /// Returns a builder for [Maintenance].
67    ///
68    /// ```
69    /// # tokio_test::block_on(async {
70    /// # use google_cloud_maintenance_api_v1::client::Maintenance;
71    /// let client = Maintenance::builder().build().await?;
72    /// # gax::client_builder::Result::<()>::Ok(()) });
73    /// ```
74    pub fn builder() -> super::builder::maintenance::ClientBuilder {
75        gax::client_builder::internal::new_builder(super::builder::maintenance::client::Factory)
76    }
77
78    /// Creates a new client from the provided stub.
79    ///
80    /// The most common case for calling this function is in tests mocking the
81    /// client's behavior.
82    pub fn from_stub<T>(stub: T) -> Self
83    where
84        T: super::stub::Maintenance + 'static,
85    {
86        Self {
87            inner: std::sync::Arc::new(stub),
88        }
89    }
90
91    pub(crate) async fn new(
92        config: gaxi::options::ClientConfig,
93    ) -> gax::client_builder::Result<Self> {
94        let inner = Self::build_inner(config).await?;
95        Ok(Self { inner })
96    }
97
98    async fn build_inner(
99        conf: gaxi::options::ClientConfig,
100    ) -> gax::client_builder::Result<std::sync::Arc<dyn super::stub::dynamic::Maintenance>> {
101        if gaxi::options::tracing_enabled(&conf) {
102            return Ok(std::sync::Arc::new(Self::build_with_tracing(conf).await?));
103        }
104        Ok(std::sync::Arc::new(Self::build_transport(conf).await?))
105    }
106
107    async fn build_transport(
108        conf: gaxi::options::ClientConfig,
109    ) -> gax::client_builder::Result<impl super::stub::Maintenance> {
110        super::transport::Maintenance::new(conf).await
111    }
112
113    async fn build_with_tracing(
114        conf: gaxi::options::ClientConfig,
115    ) -> gax::client_builder::Result<impl super::stub::Maintenance> {
116        Self::build_transport(conf)
117            .await
118            .map(super::tracing::Maintenance::new)
119    }
120
121    /// Retrieves the statistics of a specific maintenance.
122    pub fn summarize_maintenances(&self) -> super::builder::maintenance::SummarizeMaintenances {
123        super::builder::maintenance::SummarizeMaintenances::new(self.inner.clone())
124    }
125
126    /// Retrieve a collection of resource maintenances.
127    pub fn list_resource_maintenances(
128        &self,
129    ) -> super::builder::maintenance::ListResourceMaintenances {
130        super::builder::maintenance::ListResourceMaintenances::new(self.inner.clone())
131    }
132
133    /// Retrieve a single resource maintenance.
134    pub fn get_resource_maintenance(&self) -> super::builder::maintenance::GetResourceMaintenance {
135        super::builder::maintenance::GetResourceMaintenance::new(self.inner.clone())
136    }
137
138    /// Lists information about the supported locations for this service.
139    pub fn list_locations(&self) -> super::builder::maintenance::ListLocations {
140        super::builder::maintenance::ListLocations::new(self.inner.clone())
141    }
142
143    /// Gets information about a location.
144    pub fn get_location(&self) -> super::builder::maintenance::GetLocation {
145        super::builder::maintenance::GetLocation::new(self.inner.clone())
146    }
147}
google_cloud_maintenance_api_v1/client.rs

google_cloud_maintenance_api_v1/
client.rs
