google_cloud_bigquery_datapolicies_v2/

client.rs

// Copyright 2025 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 BigQuery Data Policy API.
///
/// # Example
/// ```
/// # tokio_test::block_on(async {
/// # use google_cloud_bigquery_datapolicies_v2::client::DataPolicyService;
/// let client = DataPolicyService::builder().build().await?;
/// // use `client` to make requests to the BigQuery Data Policy API.
/// # gax::client_builder::Result::<()>::Ok(()) });
/// ```
///
/// # Service Description
///
/// Data Policy Service provides APIs for managing the BigQuery Data Policy.
///
/// # Configuration
///
/// To configure `DataPolicyService` use the `with_*` methods in the type returned
/// by [builder()][DataPolicyService::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://bigquerydatapolicy.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::data_policy_service::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::data_policy_service::ClientBuilder::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
///
/// `DataPolicyService` holds a connection pool internally, it is advised to
/// create one and the reuse it.  You do not need to wrap `DataPolicyService` 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 DataPolicyService {
    inner: std::sync::Arc<dyn super::stub::dynamic::DataPolicyService>,
}

impl DataPolicyService {
    /// Returns a builder for [DataPolicyService].
    ///
    /// ```
    /// # tokio_test::block_on(async {
    /// # use google_cloud_bigquery_datapolicies_v2::client::DataPolicyService;
    /// let client = DataPolicyService::builder().build().await?;
    /// # gax::client_builder::Result::<()>::Ok(()) });
    /// ```
    pub fn builder() -> super::builder::data_policy_service::ClientBuilder {
        gax::client_builder::internal::new_builder(
            super::builder::data_policy_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::DataPolicyService + 'static,
    {
        Self {
            inner: std::sync::Arc::new(stub),
        }
    }

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

    async fn build_inner(
        conf: gaxi::options::ClientConfig,
    ) -> gax::client_builder::Result<std::sync::Arc<dyn super::stub::dynamic::DataPolicyService>>
    {
        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,
    ) -> gax::client_builder::Result<impl super::stub::DataPolicyService> {
        super::transport::DataPolicyService::new(conf).await
    }

    async fn build_with_tracing(
        conf: gaxi::options::ClientConfig,
    ) -> gax::client_builder::Result<impl super::stub::DataPolicyService> {
        Self::build_transport(conf)
            .await
            .map(super::tracing::DataPolicyService::new)
    }

    /// Creates a new data policy under a project with the given `data_policy_id`
    /// (used as the display name), and data policy type.
    pub fn create_data_policy(&self) -> super::builder::data_policy_service::CreateDataPolicy {
        super::builder::data_policy_service::CreateDataPolicy::new(self.inner.clone())
    }

    /// Adds new grantees to a data policy.
    /// The new grantees will be added to the existing grantees.
    /// If the request contains a duplicate grantee, the grantee will be ignored.
    /// If the request contains a grantee that already exists, the grantee will be
    /// ignored.
    pub fn add_grantees(&self) -> super::builder::data_policy_service::AddGrantees {
        super::builder::data_policy_service::AddGrantees::new(self.inner.clone())
    }

    /// Removes grantees from a data policy.
    /// The grantees will be removed from the existing grantees.
    /// If the request contains a grantee that does not exist, the grantee will be
    /// ignored.
    pub fn remove_grantees(&self) -> super::builder::data_policy_service::RemoveGrantees {
        super::builder::data_policy_service::RemoveGrantees::new(self.inner.clone())
    }

    /// Updates the metadata for an existing data policy. The target data policy
    /// can be specified by the resource name.
    pub fn update_data_policy(&self) -> super::builder::data_policy_service::UpdateDataPolicy {
        super::builder::data_policy_service::UpdateDataPolicy::new(self.inner.clone())
    }

    /// Deletes the data policy specified by its resource name.
    pub fn delete_data_policy(&self) -> super::builder::data_policy_service::DeleteDataPolicy {
        super::builder::data_policy_service::DeleteDataPolicy::new(self.inner.clone())
    }

    /// Gets the data policy specified by its resource name.
    pub fn get_data_policy(&self) -> super::builder::data_policy_service::GetDataPolicy {
        super::builder::data_policy_service::GetDataPolicy::new(self.inner.clone())
    }

    /// List all of the data policies in the specified parent project.
    pub fn list_data_policies(&self) -> super::builder::data_policy_service::ListDataPolicies {
        super::builder::data_policy_service::ListDataPolicies::new(self.inner.clone())
    }

    /// Gets the IAM policy for the specified data policy.
    pub fn get_iam_policy(&self) -> super::builder::data_policy_service::GetIamPolicy {
        super::builder::data_policy_service::GetIamPolicy::new(self.inner.clone())
    }

    /// Sets the IAM policy for the specified data policy.
    pub fn set_iam_policy(&self) -> super::builder::data_policy_service::SetIamPolicy {
        super::builder::data_policy_service::SetIamPolicy::new(self.inner.clone())
    }

    /// Returns the caller's permission on the specified data policy resource.
    pub fn test_iam_permissions(&self) -> super::builder::data_policy_service::TestIamPermissions {
        super::builder::data_policy_service::TestIamPermissions::new(self.inner.clone())
    }
}