Skip to content

Commit 4d0ebcd

Browse files
amanda-tarafaamanda-tarafa
committed
docs: Generate samples for simple RPCs
1 parent c37cdf6 commit 4d0ebcd

File tree

2 files changed

+196
-0
lines changed

2 files changed

+196
-0
lines changed

‎src/generated/cloud/secretmanager/v1/.sidekick.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ service-config = 'google/cloud/secretmanager/v1/secretmanager_v1.yaml'
1919
[codec]
2020
version = '1.2.0'
2121
copyright-year = '2024'
22+
generate-rpc-samples = 'true'

‎src/generated/cloud/secretmanager/v1/src/client.rs‎

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,20 @@ impl SecretManagerService {
142142
///
143143
/// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
144144
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
145+
///
146+
/// # Example
147+
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
148+
/// async fn sample(
149+
/// client: &SecretManagerService
150+
/// ) -> gax::Result<()> {
151+
/// let response = client
152+
/// .create_secret()
153+
/// /* set fields */
154+
/// .send()
155+
/// .await?;
156+
/// println!("response {:?}", response);
157+
/// Ok(());
158+
/// }
145159
pub fn create_secret(&self) -> super::builder::secret_manager_service::CreateSecret {
146160
super::builder::secret_manager_service::CreateSecret::new(self.inner.clone())
147161
}
@@ -152,13 +166,41 @@ impl SecretManagerService {
152166
///
153167
/// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
154168
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
169+
///
170+
/// # Example
171+
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
172+
/// async fn sample(
173+
/// client: &SecretManagerService
174+
/// ) -> gax::Result<()> {
175+
/// let response = client
176+
/// .add_secret_version()
177+
/// /* set fields */
178+
/// .send()
179+
/// .await?;
180+
/// println!("response {:?}", response);
181+
/// Ok(());
182+
/// }
155183
pub fn add_secret_version(&self) -> super::builder::secret_manager_service::AddSecretVersion {
156184
super::builder::secret_manager_service::AddSecretVersion::new(self.inner.clone())
157185
}
158186

159187
/// Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
160188
///
161189
/// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
190+
///
191+
/// # Example
192+
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
193+
/// async fn sample(
194+
/// client: &SecretManagerService
195+
/// ) -> gax::Result<()> {
196+
/// let response = client
197+
/// .get_secret()
198+
/// /* set fields */
199+
/// .send()
200+
/// .await?;
201+
/// println!("response {:?}", response);
202+
/// Ok(());
203+
/// }
162204
pub fn get_secret(&self) -> super::builder::secret_manager_service::GetSecret {
163205
super::builder::secret_manager_service::GetSecret::new(self.inner.clone())
164206
}
@@ -167,13 +209,40 @@ impl SecretManagerService {
167209
/// [Secret][google.cloud.secretmanager.v1.Secret].
168210
///
169211
/// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
212+
///
213+
/// # Example
214+
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
215+
/// async fn sample(
216+
/// client: &SecretManagerService
217+
/// ) -> gax::Result<()> {
218+
/// let response = client
219+
/// .update_secret()
220+
/// /* set fields */
221+
/// .send()
222+
/// .await?;
223+
/// println!("response {:?}", response);
224+
/// Ok(());
225+
/// }
170226
pub fn update_secret(&self) -> super::builder::secret_manager_service::UpdateSecret {
171227
super::builder::secret_manager_service::UpdateSecret::new(self.inner.clone())
172228
}
173229

174230
/// Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
175231
///
176232
/// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
233+
///
234+
/// # Example
235+
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
236+
/// async fn sample(
237+
/// client: &SecretManagerService
238+
/// ) -> gax::Result<()> {
239+
/// client
240+
/// .delete_secret()
241+
/// /* set fields */
242+
/// .send()
243+
/// .await;
244+
/// Ok(());
245+
/// }
177246
pub fn delete_secret(&self) -> super::builder::secret_manager_service::DeleteSecret {
178247
super::builder::secret_manager_service::DeleteSecret::new(self.inner.clone())
179248
}
@@ -195,6 +264,20 @@ impl SecretManagerService {
195264
/// created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
196265
///
197266
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
267+
///
268+
/// # Example
269+
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
270+
/// async fn sample(
271+
/// client: &SecretManagerService
272+
/// ) -> gax::Result<()> {
273+
/// let response = client
274+
/// .get_secret_version()
275+
/// /* set fields */
276+
/// .send()
277+
/// .await?;
278+
/// println!("response {:?}", response);
279+
/// Ok(());
280+
/// }
198281
pub fn get_secret_version(&self) -> super::builder::secret_manager_service::GetSecretVersion {
199282
super::builder::secret_manager_service::GetSecretVersion::new(self.inner.clone())
200283
}
@@ -206,6 +289,20 @@ impl SecretManagerService {
206289
/// created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
207290
///
208291
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
292+
///
293+
/// # Example
294+
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
295+
/// async fn sample(
296+
/// client: &SecretManagerService
297+
/// ) -> gax::Result<()> {
298+
/// let response = client
299+
/// .access_secret_version()
300+
/// /* set fields */
301+
/// .send()
302+
/// .await?;
303+
/// println!("response {:?}", response);
304+
/// Ok(());
305+
/// }
209306
pub fn access_secret_version(
210307
&self,
211308
) -> super::builder::secret_manager_service::AccessSecretVersion {
@@ -221,6 +318,20 @@ impl SecretManagerService {
221318
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
222319
/// [google.cloud.secretmanager.v1.SecretVersion.State.DISABLED]: crate::model::secret_version::State::Disabled
223320
/// [google.cloud.secretmanager.v1.SecretVersion.state]: crate::model::SecretVersion::state
321+
///
322+
/// # Example
323+
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
324+
/// async fn sample(
325+
/// client: &SecretManagerService
326+
/// ) -> gax::Result<()> {
327+
/// let response = client
328+
/// .disable_secret_version()
329+
/// /* set fields */
330+
/// .send()
331+
/// .await?;
332+
/// println!("response {:?}", response);
333+
/// Ok(());
334+
/// }
224335
pub fn disable_secret_version(
225336
&self,
226337
) -> super::builder::secret_manager_service::DisableSecretVersion {
@@ -236,6 +347,20 @@ impl SecretManagerService {
236347
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
237348
/// [google.cloud.secretmanager.v1.SecretVersion.State.ENABLED]: crate::model::secret_version::State::Enabled
238349
/// [google.cloud.secretmanager.v1.SecretVersion.state]: crate::model::SecretVersion::state
350+
///
351+
/// # Example
352+
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
353+
/// async fn sample(
354+
/// client: &SecretManagerService
355+
/// ) -> gax::Result<()> {
356+
/// let response = client
357+
/// .enable_secret_version()
358+
/// /* set fields */
359+
/// .send()
360+
/// .await?;
361+
/// println!("response {:?}", response);
362+
/// Ok(());
363+
/// }
239364
pub fn enable_secret_version(
240365
&self,
241366
) -> super::builder::secret_manager_service::EnableSecretVersion {
@@ -252,6 +377,20 @@ impl SecretManagerService {
252377
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
253378
/// [google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED]: crate::model::secret_version::State::Destroyed
254379
/// [google.cloud.secretmanager.v1.SecretVersion.state]: crate::model::SecretVersion::state
380+
///
381+
/// # Example
382+
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
383+
/// async fn sample(
384+
/// client: &SecretManagerService
385+
/// ) -> gax::Result<()> {
386+
/// let response = client
387+
/// .destroy_secret_version()
388+
/// /* set fields */
389+
/// .send()
390+
/// .await?;
391+
/// println!("response {:?}", response);
392+
/// Ok(());
393+
/// }
255394
pub fn destroy_secret_version(
256395
&self,
257396
) -> super::builder::secret_manager_service::DestroySecretVersion {
@@ -268,12 +407,40 @@ impl SecretManagerService {
268407
///
269408
/// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
270409
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
410+
///
411+
/// # Example
412+
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
413+
/// async fn sample(
414+
/// client: &SecretManagerService
415+
/// ) -> gax::Result<()> {
416+
/// let response = client
417+
/// .set_iam_policy()
418+
/// /* set fields */
419+
/// .send()
420+
/// .await?;
421+
/// println!("response {:?}", response);
422+
/// Ok(());
423+
/// }
271424
pub fn set_iam_policy(&self) -> super::builder::secret_manager_service::SetIamPolicy {
272425
super::builder::secret_manager_service::SetIamPolicy::new(self.inner.clone())
273426
}
274427

275428
/// Gets the access control policy for a secret.
276429
/// Returns empty policy if the secret exists and does not have a policy set.
430+
///
431+
/// # Example
432+
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
433+
/// async fn sample(
434+
/// client: &SecretManagerService
435+
/// ) -> gax::Result<()> {
436+
/// let response = client
437+
/// .get_iam_policy()
438+
/// /* set fields */
439+
/// .send()
440+
/// .await?;
441+
/// println!("response {:?}", response);
442+
/// Ok(());
443+
/// }
277444
pub fn get_iam_policy(&self) -> super::builder::secret_manager_service::GetIamPolicy {
278445
super::builder::secret_manager_service::GetIamPolicy::new(self.inner.clone())
279446
}
@@ -285,6 +452,20 @@ impl SecretManagerService {
285452
/// Note: This operation is designed to be used for building permission-aware
286453
/// UIs and command-line tools, not for authorization checking. This operation
287454
/// may "fail open" without warning.
455+
///
456+
/// # Example
457+
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
458+
/// async fn sample(
459+
/// client: &SecretManagerService
460+
/// ) -> gax::Result<()> {
461+
/// let response = client
462+
/// .test_iam_permissions()
463+
/// /* set fields */
464+
/// .send()
465+
/// .await?;
466+
/// println!("response {:?}", response);
467+
/// Ok(());
468+
/// }
288469
pub fn test_iam_permissions(
289470
&self,
290471
) -> super::builder::secret_manager_service::TestIamPermissions {
@@ -297,6 +478,20 @@ impl SecretManagerService {
297478
}
298479

299480
/// Gets information about a location.
481+
///
482+
/// # Example
483+
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
484+
/// async fn sample(
485+
/// client: &SecretManagerService
486+
/// ) -> gax::Result<()> {
487+
/// let response = client
488+
/// .get_location()
489+
/// /* set fields */
490+
/// .send()
491+
/// .await?;
492+
/// println!("response {:?}", response);
493+
/// Ok(());
494+
/// }
300495
pub fn get_location(&self) -> super::builder::secret_manager_service::GetLocation {
301496
super::builder::secret_manager_service::GetLocation::new(self.inner.clone())
302497
}

0 commit comments

Comments
 (0)