google_cloud_auditmanager_v1/

client.rs

// Copyright 2026 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 Audit Manager API.
///
/// # Example
/// ```
/// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
/// # use google_cloud_auditmanager_v1::client::AuditManager;
/// let client = AuditManager::builder().build().await?;
/// // use `client` to make requests to the Audit Manager API.
/// # Ok(()) }
/// ```
///
/// # Service Description
///
/// Service describing handlers for resources
///
/// # Configuration
///
/// To configure `AuditManager` use the `with_*` methods in the type returned
/// by [builder()][AuditManager::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://auditmanager.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::audit_manager::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::audit_manager::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
///
/// `AuditManager` holds a connection pool internally, it is advised to
/// create one and the reuse it.  You do not need to wrap `AuditManager` 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 AuditManager {
    inner: std::sync::Arc<dyn super::stub::dynamic::AuditManager>,
}

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

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

    /// Enrolls the customer resource(folder/project/organization) to the audit
    /// manager service by creating the audit managers Service Agent in customers
    /// workload and granting required permissions to the Service Agent. Please
    /// note that if enrollment request is made on the already enrolled workload
    /// then enrollment is executed overriding the existing set of destinations.
    pub fn enroll_resource(&self) -> super::builder::audit_manager::EnrollResource {
        super::builder::audit_manager::EnrollResource::new(self.inner.clone())
    }

    /// Generates a demo report highlighting different responsibilities
    /// (Google/Customer/ shared) required to be fulfilled for the customer's
    /// workload to be compliant with the given standard.
    pub fn generate_audit_scope_report(
        &self,
    ) -> super::builder::audit_manager::GenerateAuditScopeReport {
        super::builder::audit_manager::GenerateAuditScopeReport::new(self.inner.clone())
    }

    /// Register the Audit Report generation requests and returns the OperationId
    /// using which the customer can track the report generation progress.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    pub fn generate_audit_report(&self) -> super::builder::audit_manager::GenerateAuditReport {
        super::builder::audit_manager::GenerateAuditReport::new(self.inner.clone())
    }

    /// Lists audit reports in the selected parent scope
    pub fn list_audit_reports(&self) -> super::builder::audit_manager::ListAuditReports {
        super::builder::audit_manager::ListAuditReports::new(self.inner.clone())
    }

    /// Get the overall audit report
    pub fn get_audit_report(&self) -> super::builder::audit_manager::GetAuditReport {
        super::builder::audit_manager::GetAuditReport::new(self.inner.clone())
    }

    /// Get a resource along with its enrollment status.
    pub fn get_resource_enrollment_status(
        &self,
    ) -> super::builder::audit_manager::GetResourceEnrollmentStatus {
        super::builder::audit_manager::GetResourceEnrollmentStatus::new(self.inner.clone())
    }

    /// Fetches all resources under the parent along with their enrollment.
    pub fn list_resource_enrollment_statuses(
        &self,
    ) -> super::builder::audit_manager::ListResourceEnrollmentStatuses {
        super::builder::audit_manager::ListResourceEnrollmentStatuses::new(self.inner.clone())
    }

    /// Gets controls needed to be implemented to be compliant to a standard.
    pub fn list_controls(&self) -> super::builder::audit_manager::ListControls {
        super::builder::audit_manager::ListControls::new(self.inner.clone())
    }

    /// Lists information about the supported locations for this service.
    /// This method can be called in two ways:
    ///
    /// * **List all public locations:** Use the path `GET /v1/locations`.
    /// * **List project-visible locations:** Use the path
    ///   `GET /v1/projects/{project_id}/locations`. This may include public
    ///   locations as well as private or other locations specifically visible
    ///   to the project.
    pub fn list_locations(&self) -> super::builder::audit_manager::ListLocations {
        super::builder::audit_manager::ListLocations::new(self.inner.clone())
    }

    /// Gets information about a location.
    pub fn get_location(&self) -> super::builder::audit_manager::GetLocation {
        super::builder::audit_manager::GetLocation::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: google-cloud-longrunning::client::Operations
    pub fn list_operations(&self) -> super::builder::audit_manager::ListOperations {
        super::builder::audit_manager::ListOperations::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: google-cloud-longrunning::client::Operations
    pub fn get_operation(&self) -> super::builder::audit_manager::GetOperation {
        super::builder::audit_manager::GetOperation::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: google-cloud-longrunning::client::Operations
    pub fn delete_operation(&self) -> super::builder::audit_manager::DeleteOperation {
        super::builder::audit_manager::DeleteOperation::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: google-cloud-longrunning::client::Operations
    pub fn cancel_operation(&self) -> super::builder::audit_manager::CancelOperation {
        super::builder::audit_manager::CancelOperation::new(self.inner.clone())
    }
}