google-cloud-secretmanager-v1 1.7.0

// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Code generated by sidekick. DO NOT EDIT.
#![allow(rustdoc::redundant_explicit_links)]
#![allow(rustdoc::broken_intra_doc_links)]

/// Implements a client for the Secret Manager API.
///
/// # Example
/// ```
/// # use google_cloud_secretmanager_v1::client::SecretManagerService;
/// use google_cloud_gax::paginator::ItemPaginator as _;
/// # async fn sample() -> Result<(), Box<dyn std::error::Error>> {
///     let client = SecretManagerService::builder().build().await?;
///     let parent = "parent_value";
///     let mut list = client.list_secrets()
///         .set_parent(parent)
///         .by_item();
///     while let Some(item) = list.next().await.transpose()? {
///         println!("{:?}", item);
///     }
/// # Ok(()) }
/// ```
///
/// # Service Description
///
/// Secret Manager Service
///
/// Manages secrets and operations using those secrets. Implements a REST
/// model with the following objects:
///
/// * [Secret][google.cloud.secretmanager.v1.Secret]
/// * [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]
///
/// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
/// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
///
/// # Configuration
///
/// To configure `SecretManagerService` use the `with_*` methods in the type returned
/// by [builder()][SecretManagerService::builder]. The default configuration should
/// work for most applications. Common configuration changes include
///
/// * [with_endpoint()]: by default this client uses the global default endpoint
///   (`https://secretmanager.googleapis.com`). Applications using regional
///   endpoints or running in restricted networks (e.g. a network configured
//    with [Private Google Access with VPC Service Controls]) may want to
///   override this default.
/// * [with_credentials()]: by default this client uses
///   [Application Default Credentials]. Applications using custom
///   authentication may need to override this default.
///
/// [with_endpoint()]: super::builder::secret_manager_service::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::secret_manager_service::ClientBuilder::with_credentials
/// [Private Google Access with VPC Service Controls]: https://cloud.google.com/vpc-service-controls/docs/private-connectivity
/// [Application Default Credentials]: https://cloud.google.com/docs/authentication#adc
///
/// # Pooling and Cloning
///
/// `SecretManagerService` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `SecretManagerService` in
/// an [Rc](std::rc::Rc) or [Arc](std::sync::Arc) to reuse it, because it
/// already uses an `Arc` internally.
#[derive(Clone, Debug)]
pub struct SecretManagerService {
    inner: std::sync::Arc<dyn super::stub::dynamic::SecretManagerService>,
}

impl SecretManagerService {
    /// Returns a builder for [SecretManagerService].
    ///
    /// ```
    /// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
    /// # use google_cloud_secretmanager_v1::client::SecretManagerService;
    /// let client = SecretManagerService::builder().build().await?;
    /// # Ok(()) }
    /// ```
    pub fn builder() -> super::builder::secret_manager_service::ClientBuilder {
        crate::new_client_builder(super::builder::secret_manager_service::client::Factory)
    }

    /// Creates a new client from the provided stub.
    ///
    /// The most common case for calling this function is in tests mocking the
    /// client's behavior.
    pub fn from_stub<T>(stub: T) -> Self
    where
        T: super::stub::SecretManagerService + 'static,
    {
        Self {
            inner: std::sync::Arc::new(stub),
        }
    }

    pub(crate) async fn new(
        config: gaxi::options::ClientConfig,
    ) -> crate::ClientBuilderResult<Self> {
        let inner = Self::build_inner(config).await?;
        Ok(Self { inner })
    }

    async fn build_inner(
        conf: gaxi::options::ClientConfig,
    ) -> crate::ClientBuilderResult<std::sync::Arc<dyn super::stub::dynamic::SecretManagerService>>
    {
        if gaxi::options::tracing_enabled(&conf) {
            return Ok(std::sync::Arc::new(Self::build_with_tracing(conf).await?));
        }
        Ok(std::sync::Arc::new(Self::build_transport(conf).await?))
    }

    async fn build_transport(
        conf: gaxi::options::ClientConfig,
    ) -> crate::ClientBuilderResult<impl super::stub::SecretManagerService> {
        super::transport::SecretManagerService::new(conf).await
    }

    async fn build_with_tracing(
        conf: gaxi::options::ClientConfig,
    ) -> crate::ClientBuilderResult<impl super::stub::SecretManagerService> {
        Self::build_transport(conf)
            .await
            .map(super::tracing::SecretManagerService::new)
    }

    /// Lists [Secrets][google.cloud.secretmanager.v1.Secret].
    ///
    /// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
    ///
    /// # Example
    /// ```
    /// # use google_cloud_secretmanager_v1::client::SecretManagerService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService, parent: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_secrets()
    ///         .set_parent(parent)
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_secrets(&self) -> super::builder::secret_manager_service::ListSecrets {
        super::builder::secret_manager_service::ListSecrets::new(self.inner.clone())
    }

    /// Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no
    /// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
    ///
    /// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
    /// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
    ///
    /// # Example
    /// ```
    /// # use google_cloud_secretmanager_v1::client::SecretManagerService;
    /// use google_cloud_secretmanager_v1::model::Secret;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService, parent: &str
    /// ) -> Result<()> {
    ///     let response = client.create_secret()
    ///         .set_parent(parent)
    ///         .set_secret_id("secret_id_value")
    ///         .set_secret(
    ///             Secret::new()/* 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())
    }

    /// Creates a new [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]
    /// containing secret data and attaches it to an existing
    /// [Secret][google.cloud.secretmanager.v1.Secret].
    ///
    /// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
    /// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
    ///
    /// # Example
    /// ```
    /// # use google_cloud_secretmanager_v1::client::SecretManagerService;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService
    /// ) -> 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;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService, name: &str
    /// ) -> Result<()> {
    ///     let response = client.get_secret()
    ///         .set_name(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())
    }

    /// Updates metadata of an existing
    /// [Secret][google.cloud.secretmanager.v1.Secret].
    ///
    /// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
    ///
    /// # Example
    /// ```
    /// # use google_cloud_secretmanager_v1::client::SecretManagerService;
    /// # extern crate wkt as google_cloud_wkt;
    /// use google_cloud_wkt::FieldMask;
    /// use google_cloud_secretmanager_v1::model::Secret;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService, name: &str
    /// ) -> Result<()> {
    ///     let response = client.update_secret()
    ///         .set_secret(
    ///             Secret::new().set_name(name)/* set fields */
    ///         )
    ///         .set_update_mask(FieldMask::default().set_paths(["updated.field.path1", "updated.field.path2"]))
    ///         .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;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService, name: &str
    /// ) -> Result<()> {
    ///     client.delete_secret()
    ///         .set_name(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())
    }

    /// Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This
    /// call does not return secret data.
    ///
    /// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
    ///
    /// # Example
    /// ```
    /// # use google_cloud_secretmanager_v1::client::SecretManagerService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService, parent: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_secret_versions()
    ///         .set_parent(parent)
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_secret_versions(
        &self,
    ) -> super::builder::secret_manager_service::ListSecretVersions {
        super::builder::secret_manager_service::ListSecretVersions::new(self.inner.clone())
    }

    /// Gets metadata for a
    /// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
    ///
    /// `projects/*/secrets/*/versions/latest` is an alias to the most recently
    /// created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
    ///
    /// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
    ///
    /// # Example
    /// ```
    /// # use google_cloud_secretmanager_v1::client::SecretManagerService;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService, name: &str
    /// ) -> Result<()> {
    ///     let response = client.get_secret_version()
    ///         .set_name(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())
    }

    /// Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
    /// This call returns the secret data.
    ///
    /// `projects/*/secrets/*/versions/latest` is an alias to the most recently
    /// created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
    ///
    /// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
    ///
    /// # Example
    /// ```
    /// # use google_cloud_secretmanager_v1::client::SecretManagerService;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService
    /// ) -> 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 {
        super::builder::secret_manager_service::AccessSecretVersion::new(self.inner.clone())
    }

    /// Disables a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
    ///
    /// Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the
    /// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to
    /// [DISABLED][google.cloud.secretmanager.v1.SecretVersion.State.DISABLED].
    ///
    /// [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;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService
    /// ) -> 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 {
        super::builder::secret_manager_service::DisableSecretVersion::new(self.inner.clone())
    }

    /// Enables a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
    ///
    /// Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the
    /// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to
    /// [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED].
    ///
    /// [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;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService
    /// ) -> 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 {
        super::builder::secret_manager_service::EnableSecretVersion::new(self.inner.clone())
    }

    /// Destroys a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
    ///
    /// Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the
    /// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to
    /// [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED]
    /// and irrevocably destroys the secret data.
    ///
    /// [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;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService
    /// ) -> 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 {
        super::builder::secret_manager_service::DestroySecretVersion::new(self.inner.clone())
    }

    /// Sets the access control policy on the specified secret. Replaces any
    /// existing policy.
    ///
    /// Permissions on
    /// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] are enforced
    /// according to the policy set on the associated
    /// [Secret][google.cloud.secretmanager.v1.Secret].
    ///
    /// [google.cloud.secretmanager.v1.Secret]: crate::model::Secret
    /// [google.cloud.secretmanager.v1.SecretVersion]: crate::model::SecretVersion
    ///
    /// # Example
    /// ```
    /// # use google_cloud_secretmanager_v1::client::SecretManagerService;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService
    /// ) -> 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;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService
    /// ) -> 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())
    }

    /// Returns permissions that a caller has for the specified secret.
    /// If the secret does not exist, this call returns an empty set of
    /// permissions, not a NOT_FOUND error.
    ///
    /// 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;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService
    /// ) -> 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 {
        super::builder::secret_manager_service::TestIamPermissions::new(self.inner.clone())
    }

    /// Lists information about the supported locations for this service.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_secretmanager_v1::client::SecretManagerService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService
    /// ) -> Result<()> {
    ///     let mut list = client.list_locations()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_locations(&self) -> super::builder::secret_manager_service::ListLocations {
        super::builder::secret_manager_service::ListLocations::new(self.inner.clone())
    }

    /// Gets information about a location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_secretmanager_v1::client::SecretManagerService;
    /// use google_cloud_secretmanager_v1::Result;
    /// async fn sample(
    ///    client: &SecretManagerService
    /// ) -> 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())
    }
}