google_cloud_cloudcontrolspartner_v1/

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 Cloud Controls Partner API.
///
/// # Example
/// ```
/// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerCore;
/// use google_cloud_gax::paginator::ItemPaginator as _;
/// # async fn sample() -> Result<(), Box<dyn std::error::Error>> {
///     let client = CloudControlsPartnerCore::builder().build().await?;
///     let parent = "parent_value";
///     let mut list = client.list_workloads()
///         .set_parent(parent)
///         .by_item();
///     while let Some(item) = list.next().await.transpose()? {
///         println!("{:?}", item);
///     }
/// # Ok(()) }
/// ```
///
/// # Service Description
///
/// Service describing handlers for resources
///
/// # Configuration
///
/// To configure `CloudControlsPartnerCore` use the `with_*` methods in the type returned
/// by [builder()][CloudControlsPartnerCore::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://cloudcontrolspartner.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::cloud_controls_partner_core::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::cloud_controls_partner_core::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
///
/// `CloudControlsPartnerCore` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `CloudControlsPartnerCore` 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 CloudControlsPartnerCore {
    inner: std::sync::Arc<dyn super::stub::dynamic::CloudControlsPartnerCore>,
}

impl CloudControlsPartnerCore {
    /// Returns a builder for [CloudControlsPartnerCore].
    ///
    /// ```
    /// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerCore;
    /// let client = CloudControlsPartnerCore::builder().build().await?;
    /// # Ok(()) }
    /// ```
    pub fn builder() -> super::builder::cloud_controls_partner_core::ClientBuilder {
        crate::new_client_builder(super::builder::cloud_controls_partner_core::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::CloudControlsPartnerCore + '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::CloudControlsPartnerCore>,
    > {
        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::CloudControlsPartnerCore> {
        super::transport::CloudControlsPartnerCore::new(conf).await
    }

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

    /// Gets details of a single workload
    ///
    /// # Example
    /// ```
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerCore;
    /// use google_cloud_cloudcontrolspartner_v1::Result;
    /// async fn sample(
    ///    client: &CloudControlsPartnerCore, name: &str
    /// ) -> Result<()> {
    ///     let response = client.get_workload()
    ///         .set_name(name)
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_workload(&self) -> super::builder::cloud_controls_partner_core::GetWorkload {
        super::builder::cloud_controls_partner_core::GetWorkload::new(self.inner.clone())
    }

    /// Lists customer workloads for a given customer org id
    ///
    /// # Example
    /// ```
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerCore;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_cloudcontrolspartner_v1::Result;
    /// async fn sample(
    ///    client: &CloudControlsPartnerCore, parent: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_workloads()
    ///         .set_parent(parent)
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_workloads(&self) -> super::builder::cloud_controls_partner_core::ListWorkloads {
        super::builder::cloud_controls_partner_core::ListWorkloads::new(self.inner.clone())
    }

    /// Gets details of a single customer
    ///
    /// # Example
    /// ```
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerCore;
    /// use google_cloud_cloudcontrolspartner_v1::Result;
    /// async fn sample(
    ///    client: &CloudControlsPartnerCore, name: &str
    /// ) -> Result<()> {
    ///     let response = client.get_customer()
    ///         .set_name(name)
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_customer(&self) -> super::builder::cloud_controls_partner_core::GetCustomer {
        super::builder::cloud_controls_partner_core::GetCustomer::new(self.inner.clone())
    }

    /// Lists customers of a partner identified by its Google Cloud organization ID
    ///
    /// # Example
    /// ```
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerCore;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_cloudcontrolspartner_v1::Result;
    /// async fn sample(
    ///    client: &CloudControlsPartnerCore, parent: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_customers()
    ///         .set_parent(parent)
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_customers(&self) -> super::builder::cloud_controls_partner_core::ListCustomers {
        super::builder::cloud_controls_partner_core::ListCustomers::new(self.inner.clone())
    }

    /// Gets the EKM connections associated with a workload
    ///
    /// # Example
    /// ```
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerCore;
    /// use google_cloud_cloudcontrolspartner_v1::Result;
    /// async fn sample(
    ///    client: &CloudControlsPartnerCore, name: &str
    /// ) -> Result<()> {
    ///     let response = client.get_ekm_connections()
    ///         .set_name(name)
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_ekm_connections(
        &self,
    ) -> super::builder::cloud_controls_partner_core::GetEkmConnections {
        super::builder::cloud_controls_partner_core::GetEkmConnections::new(self.inner.clone())
    }

    /// Gets the partner permissions granted for a workload
    ///
    /// # Example
    /// ```
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerCore;
    /// use google_cloud_cloudcontrolspartner_v1::Result;
    /// async fn sample(
    ///    client: &CloudControlsPartnerCore, name: &str
    /// ) -> Result<()> {
    ///     let response = client.get_partner_permissions()
    ///         .set_name(name)
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_partner_permissions(
        &self,
    ) -> super::builder::cloud_controls_partner_core::GetPartnerPermissions {
        super::builder::cloud_controls_partner_core::GetPartnerPermissions::new(self.inner.clone())
    }

    /// Deprecated: Only returns access approval requests directly associated with
    /// an assured workload folder.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerCore;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_cloudcontrolspartner_v1::Result;
    /// async fn sample(
    ///    client: &CloudControlsPartnerCore, parent: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_access_approval_requests()
    ///         .set_parent(parent)
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    #[deprecated]
    pub fn list_access_approval_requests(
        &self,
    ) -> super::builder::cloud_controls_partner_core::ListAccessApprovalRequests {
        super::builder::cloud_controls_partner_core::ListAccessApprovalRequests::new(
            self.inner.clone(),
        )
    }

    /// Get details of a Partner.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerCore;
    /// use google_cloud_cloudcontrolspartner_v1::Result;
    /// async fn sample(
    ///    client: &CloudControlsPartnerCore, name: &str
    /// ) -> Result<()> {
    ///     let response = client.get_partner()
    ///         .set_name(name)
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_partner(&self) -> super::builder::cloud_controls_partner_core::GetPartner {
        super::builder::cloud_controls_partner_core::GetPartner::new(self.inner.clone())
    }

    /// Creates a new customer.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerCore;
    /// use google_cloud_cloudcontrolspartner_v1::model::Customer;
    /// use google_cloud_cloudcontrolspartner_v1::Result;
    /// async fn sample(
    ///    client: &CloudControlsPartnerCore, parent: &str
    /// ) -> Result<()> {
    ///     let response = client.create_customer()
    ///         .set_parent(parent)
    ///         .set_customer_id("customer_id_value")
    ///         .set_customer(
    ///             Customer::new()/* set fields */
    ///         )
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_customer(&self) -> super::builder::cloud_controls_partner_core::CreateCustomer {
        super::builder::cloud_controls_partner_core::CreateCustomer::new(self.inner.clone())
    }

    /// Update details of a single customer
    ///
    /// # Example
    /// ```
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerCore;
    /// # extern crate wkt as google_cloud_wkt;
    /// use google_cloud_wkt::FieldMask;
    /// use google_cloud_cloudcontrolspartner_v1::model::Customer;
    /// use google_cloud_cloudcontrolspartner_v1::Result;
    /// async fn sample(
    ///    client: &CloudControlsPartnerCore, name: &str
    /// ) -> Result<()> {
    ///     let response = client.update_customer()
    ///         .set_customer(
    ///             Customer::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_customer(&self) -> super::builder::cloud_controls_partner_core::UpdateCustomer {
        super::builder::cloud_controls_partner_core::UpdateCustomer::new(self.inner.clone())
    }

    /// Delete details of a single customer
    ///
    /// # Example
    /// ```
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerCore;
    /// use google_cloud_cloudcontrolspartner_v1::Result;
    /// async fn sample(
    ///    client: &CloudControlsPartnerCore, name: &str
    /// ) -> Result<()> {
    ///     client.delete_customer()
    ///         .set_name(name)
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_customer(&self) -> super::builder::cloud_controls_partner_core::DeleteCustomer {
        super::builder::cloud_controls_partner_core::DeleteCustomer::new(self.inner.clone())
    }
}

/// Implements a client for the Cloud Controls Partner API.
///
/// # Example
/// ```
/// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerMonitoring;
/// use google_cloud_gax::paginator::ItemPaginator as _;
/// # async fn sample() -> Result<(), Box<dyn std::error::Error>> {
///     let client = CloudControlsPartnerMonitoring::builder().build().await?;
///     let parent = "parent_value";
///     let mut list = client.list_violations()
///         .set_parent(parent)
///         .by_item();
///     while let Some(item) = list.next().await.transpose()? {
///         println!("{:?}", item);
///     }
/// # Ok(()) }
/// ```
///
/// # Service Description
///
/// Service describing handlers for resources
///
/// # Configuration
///
/// To configure `CloudControlsPartnerMonitoring` use the `with_*` methods in the type returned
/// by [builder()][CloudControlsPartnerMonitoring::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://cloudcontrolspartner.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::cloud_controls_partner_monitoring::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::cloud_controls_partner_monitoring::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
///
/// `CloudControlsPartnerMonitoring` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `CloudControlsPartnerMonitoring` 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 CloudControlsPartnerMonitoring {
    inner: std::sync::Arc<dyn super::stub::dynamic::CloudControlsPartnerMonitoring>,
}

impl CloudControlsPartnerMonitoring {
    /// Returns a builder for [CloudControlsPartnerMonitoring].
    ///
    /// ```
    /// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerMonitoring;
    /// let client = CloudControlsPartnerMonitoring::builder().build().await?;
    /// # Ok(()) }
    /// ```
    pub fn builder() -> super::builder::cloud_controls_partner_monitoring::ClientBuilder {
        crate::new_client_builder(
            super::builder::cloud_controls_partner_monitoring::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::CloudControlsPartnerMonitoring + '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::CloudControlsPartnerMonitoring>,
    > {
        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::CloudControlsPartnerMonitoring> {
        super::transport::CloudControlsPartnerMonitoring::new(conf).await
    }

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

    /// Lists Violations for a workload
    /// Callers may also choose to read across multiple Customers or for a single
    /// customer as per
    /// [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash
    /// character) as a wildcard character instead of {customer} & {workload}.
    /// Format:
    /// `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}`
    ///
    /// # Example
    /// ```
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerMonitoring;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_cloudcontrolspartner_v1::Result;
    /// async fn sample(
    ///    client: &CloudControlsPartnerMonitoring, parent: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_violations()
    ///         .set_parent(parent)
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_violations(
        &self,
    ) -> super::builder::cloud_controls_partner_monitoring::ListViolations {
        super::builder::cloud_controls_partner_monitoring::ListViolations::new(self.inner.clone())
    }

    /// Gets details of a single Violation.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_cloudcontrolspartner_v1::client::CloudControlsPartnerMonitoring;
    /// use google_cloud_cloudcontrolspartner_v1::Result;
    /// async fn sample(
    ///    client: &CloudControlsPartnerMonitoring, name: &str
    /// ) -> Result<()> {
    ///     let response = client.get_violation()
    ///         .set_name(name)
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_violation(&self) -> super::builder::cloud_controls_partner_monitoring::GetViolation {
        super::builder::cloud_controls_partner_monitoring::GetViolation::new(self.inner.clone())
    }
}