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

impl SecurityPosture {
    /// Returns a builder for [SecurityPosture].
    ///
    /// ```
    /// # async fn sample() -> gax::client_builder::Result<()> {
    /// # use google_cloud_securityposture_v1::client::SecurityPosture;
    /// let client = SecurityPosture::builder().build().await?;
    /// # Ok(()) }
    /// ```
    pub fn builder() -> super::builder::security_posture::ClientBuilder {
        gax::client_builder::internal::new_builder(
            super::builder::security_posture::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::SecurityPosture + '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::SecurityPosture>>
    {
        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::SecurityPosture> {
        super::transport::SecurityPosture::new(conf).await
    }

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

    /// (-- This option restricts the visibility of the API to only projects that
    /// will
    /// (-- be labeled as `PREVIEW` or `GOOGLE_INTERNAL` by the service.
    /// (-- option (google.api.api_visibility).restriction =
    /// "PREVIEW,GOOGLE_INTERNAL"; Postures Lists Postures in a given organization
    /// and location. In case a posture has multiple revisions, the latest revision
    /// as per UpdateTime will be returned.
    pub fn list_postures(&self) -> super::builder::security_posture::ListPostures {
        super::builder::security_posture::ListPostures::new(self.inner.clone())
    }

    /// Lists revisions of a Posture in a given organization and location.
    pub fn list_posture_revisions(&self) -> super::builder::security_posture::ListPostureRevisions {
        super::builder::security_posture::ListPostureRevisions::new(self.inner.clone())
    }

    /// Gets a posture in a given organization and location.
    /// User must provide revision_id to retrieve a specific revision of the
    /// resource.
    /// NOT_FOUND error is returned if the revision_id or the Posture name does not
    /// exist. In case revision_id is not provided then the latest Posture revision
    /// by UpdateTime is returned.
    pub fn get_posture(&self) -> super::builder::security_posture::GetPosture {
        super::builder::security_posture::GetPosture::new(self.inner.clone())
    }

    /// Creates a new Posture resource.
    /// If a Posture with the specified name already exists in the specified
    /// organization and location, the long running operation returns a
    /// [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.
    ///
    /// # 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 create_posture(&self) -> super::builder::security_posture::CreatePosture {
        super::builder::security_posture::CreatePosture::new(self.inner.clone())
    }

    /// Updates an existing Posture.
    /// A new revision of the posture will be created if the revision to be
    /// updated is currently deployed on a workload.
    /// Returns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the
    /// Posture does not exist.
    /// Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etag
    /// supplied in the request does not match the persisted etag of the Posture.
    /// Updatable fields are state, description and policy_sets.
    /// State update operation cannot be clubbed with update of description and
    /// policy_sets.
    /// An ACTIVE posture can be updated to both DRAFT or DEPRECATED states.
    /// Postures in DRAFT or DEPRECATED states can only be updated to ACTIVE state.
    ///
    /// # 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 update_posture(&self) -> super::builder::security_posture::UpdatePosture {
        super::builder::security_posture::UpdatePosture::new(self.inner.clone())
    }

    /// Deletes all the revisions of a resource.
    /// A posture can only be deleted when none of the revisions are deployed to
    /// any workload.
    ///
    /// # 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 delete_posture(&self) -> super::builder::security_posture::DeletePosture {
        super::builder::security_posture::DeletePosture::new(self.inner.clone())
    }

    /// Extracts existing policies on a workload as a posture.
    /// If a Posture on the given workload already exists, the long running
    /// operation returns a [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.
    ///
    /// # 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 extract_posture(&self) -> super::builder::security_posture::ExtractPosture {
        super::builder::security_posture::ExtractPosture::new(self.inner.clone())
    }

    /// PostureDeployments
    /// Lists PostureDeployments in a given project and location.
    pub fn list_posture_deployments(
        &self,
    ) -> super::builder::security_posture::ListPostureDeployments {
        super::builder::security_posture::ListPostureDeployments::new(self.inner.clone())
    }

    /// Gets details of a single PostureDeployment.
    pub fn get_posture_deployment(&self) -> super::builder::security_posture::GetPostureDeployment {
        super::builder::security_posture::GetPostureDeployment::new(self.inner.clone())
    }

    /// Creates a new PostureDeployment in a given project and location.
    ///
    /// # 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 create_posture_deployment(
        &self,
    ) -> super::builder::security_posture::CreatePostureDeployment {
        super::builder::security_posture::CreatePostureDeployment::new(self.inner.clone())
    }

    /// Updates the parameters of a single PostureDeployment.
    ///
    /// # 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 update_posture_deployment(
        &self,
    ) -> super::builder::security_posture::UpdatePostureDeployment {
        super::builder::security_posture::UpdatePostureDeployment::new(self.inner.clone())
    }

    /// Deletes a single PostureDeployment.
    ///
    /// # 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 delete_posture_deployment(
        &self,
    ) -> super::builder::security_posture::DeletePostureDeployment {
        super::builder::security_posture::DeletePostureDeployment::new(self.inner.clone())
    }

    /// PostureTemplates
    /// Lists all the PostureTemplates available to the user.
    pub fn list_posture_templates(&self) -> super::builder::security_posture::ListPostureTemplates {
        super::builder::security_posture::ListPostureTemplates::new(self.inner.clone())
    }

    /// Gets a PostureTemplate.
    /// User must provide revision_id to retrieve a specific revision of the
    /// resource.
    /// NOT_FOUND error is returned if the revision_id or the PostureTemplate name
    /// does not exist. In case revision_id is not provided then the
    /// PostureTemplate with latest revision_id is returned.
    pub fn get_posture_template(&self) -> super::builder::security_posture::GetPostureTemplate {
        super::builder::security_posture::GetPostureTemplate::new(self.inner.clone())
    }

    /// Lists information about the supported locations for this service.
    pub fn list_locations(&self) -> super::builder::security_posture::ListLocations {
        super::builder::security_posture::ListLocations::new(self.inner.clone())
    }

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

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

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

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

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