Skip to content

docs: Generate samples for simple RPCs #4095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
amanda-tarafa wants to merge 3 commits into
base: main
Choose a base branch
from
+819 −0
Draft

docs: Generate samples for simple RPCs #4095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e7ec68
docs: Generate samples for simple RPCs
amanda-tarafa Dec 18, 2025
7eadc3f
docs: Generate samples for get RPCs
amanda-tarafa Dec 19, 2025
0f965e3
docs: Generate samples for non-LRO delete RPCs
amanda-tarafa Dec 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/generated/cloud/secretmanager/v1/.sidekick.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ service-config = 'google/cloud/secretmanager/v1/secretmanager_v1.yaml'
[codec]
version = '1.2.0'
copyright-year = '2024'
generate-rpc-samples = 'true'
226 changes: 226 additions & 0 deletions src/generated/cloud/secretmanager/v1/src/client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,22 @@ impl SecretManagerService {
///
/// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// async fn sample(
/// client: &SecretManagerService
/// ) -> gax::Result<()> {
/// let response = client
/// .create_secret()
/// /* set fields */
/// .send()
/// .await?;
/// println!("response {:?}", response);
/// Ok(())
/// }
/// ```
pub fn create_secret(&self) -> super::builder::secret_manager_service::CreateSecret {
super::builder::secret_manager_service::CreateSecret::new(self.inner.clone())
}
Expand All @@ -152,13 +168,46 @@ impl SecretManagerService {
///
/// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// async fn sample(
/// client: &SecretManagerService
/// ) -> gax::Result<()> {
Copy link
Member

@dbolduc dbolduc Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I think we would prefer to use the re-exported Result over gax::Result:

# use google_cloud_secretmanager_v1::Result;
async fn sample(...) -> Result<()> { ... }

/// let response = client
/// .add_secret_version()
/// /* set fields */
/// .send()
/// .await?;
/// println!("response {:?}", response);
/// Ok(())
/// }
/// ```
pub fn add_secret_version(&self) -> super::builder::secret_manager_service::AddSecretVersion {
super::builder::secret_manager_service::AddSecretVersion::new(self.inner.clone())
}

/// Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
///
/// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// async fn sample(
/// client: &SecretManagerService,
/// resource_name: &str
/// ) -> gax::Result<()> {
/// let response = client
/// .get_secret()
/// .set_name(resource_name)
/// .send()
/// .await?;
/// println!("response {:?}", response);
/// Ok(())
/// }
/// ```
pub fn get_secret(&self) -> super::builder::secret_manager_service::GetSecret {
super::builder::secret_manager_service::GetSecret::new(self.inner.clone())
}
Expand All @@ -167,13 +216,45 @@ impl SecretManagerService {
/// [Secret][google.cloud.secretmanager.v1.Secret].
///
/// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// async fn sample(
/// client: &SecretManagerService
/// ) -> gax::Result<()> {
/// let response = client
/// .update_secret()
/// /* set fields */
/// .send()
/// .await?;
/// println!("response {:?}", response);
/// Ok(())
/// }
/// ```
pub fn update_secret(&self) -> super::builder::secret_manager_service::UpdateSecret {
super::builder::secret_manager_service::UpdateSecret::new(self.inner.clone())
}

/// Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
///
/// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// async fn sample(
/// client: &SecretManagerService,
/// resource_name: &str
/// ) -> gax::Result<()> {
/// client
/// .delete_secret()
/// .set_name(resource_name)
/// .send()
/// .await?;
/// Ok(())
/// }
/// ```
pub fn delete_secret(&self) -> super::builder::secret_manager_service::DeleteSecret {
super::builder::secret_manager_service::DeleteSecret::new(self.inner.clone())
}
Expand All @@ -195,6 +276,23 @@ impl SecretManagerService {
/// created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
///
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// async fn sample(
/// client: &SecretManagerService,
/// resource_name: &str
/// ) -> gax::Result<()> {
/// let response = client
/// .get_secret_version()
/// .set_name(resource_name)
/// .send()
/// .await?;
/// println!("response {:?}", response);
/// Ok(())
/// }
/// ```
pub fn get_secret_version(&self) -> super::builder::secret_manager_service::GetSecretVersion {
super::builder::secret_manager_service::GetSecretVersion::new(self.inner.clone())
}
Expand All @@ -206,6 +304,22 @@ impl SecretManagerService {
/// created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
///
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// async fn sample(
/// client: &SecretManagerService
/// ) -> gax::Result<()> {
/// let response = client
/// .access_secret_version()
/// /* set fields */
/// .send()
/// .await?;
/// println!("response {:?}", response);
/// Ok(())
/// }
/// ```
pub fn access_secret_version(
&self,
) -> super::builder::secret_manager_service::AccessSecretVersion {
Expand All @@ -221,6 +335,22 @@ impl SecretManagerService {
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
/// [google.cloud.secretmanager.v1.SecretVersion.State.DISABLED]: crate::model::secret_version::State::Disabled
/// [google.cloud.secretmanager.v1.SecretVersion.state]: crate::model::SecretVersion::state
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// async fn sample(
/// client: &SecretManagerService
/// ) -> gax::Result<()> {
/// let response = client
/// .disable_secret_version()
/// /* set fields */
/// .send()
/// .await?;
/// println!("response {:?}", response);
/// Ok(())
/// }
/// ```
pub fn disable_secret_version(
&self,
) -> super::builder::secret_manager_service::DisableSecretVersion {
Expand All @@ -236,6 +366,22 @@ impl SecretManagerService {
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
/// [google.cloud.secretmanager.v1.SecretVersion.State.ENABLED]: crate::model::secret_version::State::Enabled
/// [google.cloud.secretmanager.v1.SecretVersion.state]: crate::model::SecretVersion::state
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// async fn sample(
/// client: &SecretManagerService
/// ) -> gax::Result<()> {
/// let response = client
/// .enable_secret_version()
/// /* set fields */
/// .send()
/// .await?;
/// println!("response {:?}", response);
/// Ok(())
/// }
/// ```
pub fn enable_secret_version(
&self,
) -> super::builder::secret_manager_service::EnableSecretVersion {
Expand All @@ -252,6 +398,22 @@ impl SecretManagerService {
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
/// [google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED]: crate::model::secret_version::State::Destroyed
/// [google.cloud.secretmanager.v1.SecretVersion.state]: crate::model::SecretVersion::state
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// async fn sample(
/// client: &SecretManagerService
/// ) -> gax::Result<()> {
/// let response = client
/// .destroy_secret_version()
/// /* set fields */
/// .send()
/// .await?;
/// println!("response {:?}", response);
/// Ok(())
/// }
/// ```
pub fn destroy_secret_version(
&self,
) -> super::builder::secret_manager_service::DestroySecretVersion {
Expand All @@ -268,12 +430,44 @@ impl SecretManagerService {
///
/// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// async fn sample(
/// client: &SecretManagerService
/// ) -> gax::Result<()> {
/// let response = client
/// .set_iam_policy()
/// /* set fields */
/// .send()
/// .await?;
/// println!("response {:?}", response);
/// Ok(())
/// }
/// ```
pub fn set_iam_policy(&self) -> super::builder::secret_manager_service::SetIamPolicy {
super::builder::secret_manager_service::SetIamPolicy::new(self.inner.clone())
}

/// Gets the access control policy for a secret.
/// Returns empty policy if the secret exists and does not have a policy set.
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// async fn sample(
/// client: &SecretManagerService
/// ) -> gax::Result<()> {
/// let response = client
/// .get_iam_policy()
/// /* set fields */
/// .send()
/// .await?;
/// println!("response {:?}", response);
/// Ok(())
/// }
/// ```
pub fn get_iam_policy(&self) -> super::builder::secret_manager_service::GetIamPolicy {
super::builder::secret_manager_service::GetIamPolicy::new(self.inner.clone())
}
Expand All @@ -285,6 +479,22 @@ impl SecretManagerService {
/// Note: This operation is designed to be used for building permission-aware
/// UIs and command-line tools, not for authorization checking. This operation
/// may "fail open" without warning.
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// async fn sample(
/// client: &SecretManagerService
/// ) -> gax::Result<()> {
/// let response = client
/// .test_iam_permissions()
/// /* set fields */
/// .send()
/// .await?;
/// println!("response {:?}", response);
/// Ok(())
/// }
/// ```
pub fn test_iam_permissions(
&self,
) -> super::builder::secret_manager_service::TestIamPermissions {
Expand All @@ -297,6 +507,22 @@ impl SecretManagerService {
}

/// Gets information about a location.
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// async fn sample(
/// client: &SecretManagerService
/// ) -> gax::Result<()> {
/// let response = client
/// .get_location()
/// /* set fields */
/// .send()
/// .await?;
/// println!("response {:?}", response);
/// Ok(())
/// }
/// ```
pub fn get_location(&self) -> super::builder::secret_manager_service::GetLocation {
super::builder::secret_manager_service::GetLocation::new(self.inner.clone())
}
Expand Down
1 change: 1 addition & 0 deletions src/generated/cloud/speech/v2/.sidekick.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ service-config = 'google/cloud/speech/v2/speech_v2.yaml'
[codec]
version = '1.3.0'
copyright-year = '2025'
generate-rpc-samples = 'true'
Loading