google_cloud_confidentialcomputing_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 Confidential Computing API.
20///
21/// # Example
22/// ```
23/// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
24/// # use google_cloud_confidentialcomputing_v1::client::ConfidentialComputing;
25/// let client = ConfidentialComputing::builder().build().await?;
26/// // use `client` to make requests to the Confidential Computing API.
27/// # Ok(()) }
28/// ```
29///
30/// # Service Description
31///
32/// Service describing handlers for resources
33///
34/// # Configuration
35///
36/// To configure `ConfidentialComputing` use the `with_*` methods in the type returned
37/// by [builder()][ConfidentialComputing::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://confidentialcomputing.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::confidential_computing::ClientBuilder::with_endpoint
50/// [with_credentials()]: super::builder::confidential_computing::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/// `ConfidentialComputing` holds a connection pool internally, it is advised to
57/// create one and the reuse it. You do not need to wrap `ConfidentialComputing` 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 ConfidentialComputing {
62 inner: std::sync::Arc<dyn super::stub::dynamic::ConfidentialComputing>,
63}
64
65impl ConfidentialComputing {
66 /// Returns a builder for [ConfidentialComputing].
67 ///
68 /// ```
69 /// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
70 /// # use google_cloud_confidentialcomputing_v1::client::ConfidentialComputing;
71 /// let client = ConfidentialComputing::builder().build().await?;
72 /// # Ok(()) }
73 /// ```
74 pub fn builder() -> super::builder::confidential_computing::ClientBuilder {
75 crate::new_client_builder(super::builder::confidential_computing::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::ConfidentialComputing + '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 ) -> crate::ClientBuilderResult<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 ) -> crate::ClientBuilderResult<std::sync::Arc<dyn super::stub::dynamic::ConfidentialComputing>>
101 {
102 if gaxi::options::tracing_enabled(&conf) {
103 return Ok(std::sync::Arc::new(Self::build_with_tracing(conf).await?));
104 }
105 Ok(std::sync::Arc::new(Self::build_transport(conf).await?))
106 }
107
108 async fn build_transport(
109 conf: gaxi::options::ClientConfig,
110 ) -> crate::ClientBuilderResult<impl super::stub::ConfidentialComputing> {
111 super::transport::ConfidentialComputing::new(conf).await
112 }
113
114 async fn build_with_tracing(
115 conf: gaxi::options::ClientConfig,
116 ) -> crate::ClientBuilderResult<impl super::stub::ConfidentialComputing> {
117 Self::build_transport(conf)
118 .await
119 .map(super::tracing::ConfidentialComputing::new)
120 }
121
122 /// Creates a new Challenge in a given project and location.
123 pub fn create_challenge(&self) -> super::builder::confidential_computing::CreateChallenge {
124 super::builder::confidential_computing::CreateChallenge::new(self.inner.clone())
125 }
126
127 /// Verifies the provided attestation info, returning a signed attestation
128 /// token.
129 pub fn verify_attestation(&self) -> super::builder::confidential_computing::VerifyAttestation {
130 super::builder::confidential_computing::VerifyAttestation::new(self.inner.clone())
131 }
132
133 /// Verifies whether the provided attestation info is valid, returning a signed
134 /// attestation token if so.
135 pub fn verify_confidential_space(
136 &self,
137 ) -> super::builder::confidential_computing::VerifyConfidentialSpace {
138 super::builder::confidential_computing::VerifyConfidentialSpace::new(self.inner.clone())
139 }
140
141 /// Verifies the provided Confidential GKE attestation info, returning a signed
142 /// OIDC token.
143 pub fn verify_confidential_gke(
144 &self,
145 ) -> super::builder::confidential_computing::VerifyConfidentialGke {
146 super::builder::confidential_computing::VerifyConfidentialGke::new(self.inner.clone())
147 }
148
149 /// Lists information about the supported locations for this service.
150 /// This method can be called in two ways:
151 ///
152 /// * **List all public locations:** Use the path `GET /v1/locations`.
153 /// * **List project-visible locations:** Use the path
154 /// `GET /v1/projects/{project_id}/locations`. This may include public
155 /// locations as well as private or other locations specifically visible
156 /// to the project.
157 pub fn list_locations(&self) -> super::builder::confidential_computing::ListLocations {
158 super::builder::confidential_computing::ListLocations::new(self.inner.clone())
159 }
160
161 /// Gets information about a location.
162 pub fn get_location(&self) -> super::builder::confidential_computing::GetLocation {
163 super::builder::confidential_computing::GetLocation::new(self.inner.clone())
164 }
165}