google_cloud_essentialcontacts_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 Essential Contacts API.
20///
21/// # Example
22/// ```
23/// # async fn sample() -> gax::client_builder::Result<()> {
24/// # use google_cloud_essentialcontacts_v1::client::EssentialContactsService;
25/// let client = EssentialContactsService::builder().build().await?;
26/// // use `client` to make requests to the Essential Contacts API.
27/// # Ok(()) }
28/// ```
29///
30/// # Service Description
31///
32/// Manages contacts for important Google Cloud notifications.
33///
34/// # Configuration
35///
36/// To configure `EssentialContactsService` use the `with_*` methods in the type returned
37/// by [builder()][EssentialContactsService::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://essentialcontacts.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::essential_contacts_service::ClientBuilder::with_endpoint
50/// [with_credentials()]: super::builder::essential_contacts_service::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/// `EssentialContactsService` holds a connection pool internally, it is advised to
57/// create one and the reuse it.  You do not need to wrap `EssentialContactsService` 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 EssentialContactsService {
62    inner: std::sync::Arc<dyn super::stub::dynamic::EssentialContactsService>,
63}
64
65impl EssentialContactsService {
66    /// Returns a builder for [EssentialContactsService].
67    ///
68    /// ```
69    /// # async fn sample() -> gax::client_builder::Result<()> {
70    /// # use google_cloud_essentialcontacts_v1::client::EssentialContactsService;
71    /// let client = EssentialContactsService::builder().build().await?;
72    /// # Ok(()) }
73    /// ```
74    pub fn builder() -> super::builder::essential_contacts_service::ClientBuilder {
75        gax::client_builder::internal::new_builder(
76            super::builder::essential_contacts_service::client::Factory,
77        )
78    }
79
80    /// Creates a new client from the provided stub.
81    ///
82    /// The most common case for calling this function is in tests mocking the
83    /// client's behavior.
84    pub fn from_stub<T>(stub: T) -> Self
85    where
86        T: super::stub::EssentialContactsService + 'static,
87    {
88        Self {
89            inner: std::sync::Arc::new(stub),
90        }
91    }
92
93    pub(crate) async fn new(
94        config: gaxi::options::ClientConfig,
95    ) -> gax::client_builder::Result<Self> {
96        let inner = Self::build_inner(config).await?;
97        Ok(Self { inner })
98    }
99
100    async fn build_inner(
101        conf: gaxi::options::ClientConfig,
102    ) -> gax::client_builder::Result<
103        std::sync::Arc<dyn super::stub::dynamic::EssentialContactsService>,
104    > {
105        if gaxi::options::tracing_enabled(&conf) {
106            return Ok(std::sync::Arc::new(Self::build_with_tracing(conf).await?));
107        }
108        Ok(std::sync::Arc::new(Self::build_transport(conf).await?))
109    }
110
111    async fn build_transport(
112        conf: gaxi::options::ClientConfig,
113    ) -> gax::client_builder::Result<impl super::stub::EssentialContactsService> {
114        super::transport::EssentialContactsService::new(conf).await
115    }
116
117    async fn build_with_tracing(
118        conf: gaxi::options::ClientConfig,
119    ) -> gax::client_builder::Result<impl super::stub::EssentialContactsService> {
120        Self::build_transport(conf)
121            .await
122            .map(super::tracing::EssentialContactsService::new)
123    }
124
125    /// Adds a new contact for a resource.
126    pub fn create_contact(&self) -> super::builder::essential_contacts_service::CreateContact {
127        super::builder::essential_contacts_service::CreateContact::new(self.inner.clone())
128    }
129
130    /// Updates a contact.
131    /// Note: A contact's email address cannot be changed.
132    pub fn update_contact(&self) -> super::builder::essential_contacts_service::UpdateContact {
133        super::builder::essential_contacts_service::UpdateContact::new(self.inner.clone())
134    }
135
136    /// Lists the contacts that have been set on a resource.
137    pub fn list_contacts(&self) -> super::builder::essential_contacts_service::ListContacts {
138        super::builder::essential_contacts_service::ListContacts::new(self.inner.clone())
139    }
140
141    /// Gets a single contact.
142    pub fn get_contact(&self) -> super::builder::essential_contacts_service::GetContact {
143        super::builder::essential_contacts_service::GetContact::new(self.inner.clone())
144    }
145
146    /// Deletes a contact.
147    pub fn delete_contact(&self) -> super::builder::essential_contacts_service::DeleteContact {
148        super::builder::essential_contacts_service::DeleteContact::new(self.inner.clone())
149    }
150
151    /// Lists all contacts for the resource that are subscribed to the
152    /// specified notification categories, including contacts inherited from
153    /// any parent resources.
154    pub fn compute_contacts(&self) -> super::builder::essential_contacts_service::ComputeContacts {
155        super::builder::essential_contacts_service::ComputeContacts::new(self.inner.clone())
156    }
157
158    /// Allows a contact admin to send a test message to contact to verify that it
159    /// has been configured correctly.
160    pub fn send_test_message(&self) -> super::builder::essential_contacts_service::SendTestMessage {
161        super::builder::essential_contacts_service::SendTestMessage::new(self.inner.clone())
162    }
163}
google_cloud_essentialcontacts_v1/client.rs

google_cloud_essentialcontacts_v1/
client.rs
