google-cloud-iam-v3 1.5.0

// 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 Identity and Access Management (IAM) API.
///
/// # Example
/// ```
/// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
/// # use google_cloud_iam_v3::client::PolicyBindings;
/// let client = PolicyBindings::builder().build().await?;
/// // use `client` to make requests to the Identity and Access Management (IAM) API.
/// # Ok(()) }
/// ```
///
/// # Service Description
///
/// An interface for managing Identity and Access Management (IAM) policy
/// bindings.
///
/// # Configuration
///
/// To configure `PolicyBindings` use the `with_*` methods in the type returned
/// by [builder()][PolicyBindings::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://iam.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::policy_bindings::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::policy_bindings::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
///
/// `PolicyBindings` holds a connection pool internally, it is advised to
/// create one and the reuse it.  You do not need to wrap `PolicyBindings` 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 PolicyBindings {
    inner: std::sync::Arc<dyn super::stub::dynamic::PolicyBindings>,
}

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

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

    /// Creates a policy binding and returns a long-running operation.
    /// Callers will need the IAM permissions on both the policy and target.
    /// Once the binding is created, the policy is applied to the target.
    ///
    /// # 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_policy_binding(&self) -> super::builder::policy_bindings::CreatePolicyBinding {
        super::builder::policy_bindings::CreatePolicyBinding::new(self.inner.clone())
    }

    /// Gets a policy binding.
    pub fn get_policy_binding(&self) -> super::builder::policy_bindings::GetPolicyBinding {
        super::builder::policy_bindings::GetPolicyBinding::new(self.inner.clone())
    }

    /// Updates a policy binding and returns a long-running operation.
    /// Callers will need the IAM permissions on the policy and target in the
    /// binding to update, and the IAM permission to remove the existing policy
    /// from the binding. Target is immutable and cannot be updated. Once the
    /// binding is updated, the new policy is applied to the target.
    ///
    /// # 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_policy_binding(&self) -> super::builder::policy_bindings::UpdatePolicyBinding {
        super::builder::policy_bindings::UpdatePolicyBinding::new(self.inner.clone())
    }

    /// Deletes a policy binding and returns a long-running operation.
    /// Callers will need the IAM permissions on both the policy and target.
    /// Once the binding is deleted, the policy no longer applies to the target.
    ///
    /// # 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_policy_binding(&self) -> super::builder::policy_bindings::DeletePolicyBinding {
        super::builder::policy_bindings::DeletePolicyBinding::new(self.inner.clone())
    }

    /// Lists policy bindings.
    pub fn list_policy_bindings(&self) -> super::builder::policy_bindings::ListPolicyBindings {
        super::builder::policy_bindings::ListPolicyBindings::new(self.inner.clone())
    }

    /// Search policy bindings by target. Returns all policy binding objects bound
    /// directly to target.
    pub fn search_target_policy_bindings(
        &self,
    ) -> super::builder::policy_bindings::SearchTargetPolicyBindings {
        super::builder::policy_bindings::SearchTargetPolicyBindings::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::policy_bindings::GetOperation {
        super::builder::policy_bindings::GetOperation::new(self.inner.clone())
    }
}

/// Implements a client for the Identity and Access Management (IAM) API.
///
/// # Example
/// ```
/// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
/// # use google_cloud_iam_v3::client::PrincipalAccessBoundaryPolicies;
/// let client = PrincipalAccessBoundaryPolicies::builder().build().await?;
/// // use `client` to make requests to the Identity and Access Management (IAM) API.
/// # Ok(()) }
/// ```
///
/// # Service Description
///
/// Manages Identity and Access Management (IAM) principal access boundary
/// policies.
///
/// # Configuration
///
/// To configure `PrincipalAccessBoundaryPolicies` use the `with_*` methods in the type returned
/// by [builder()][PrincipalAccessBoundaryPolicies::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://iam.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::principal_access_boundary_policies::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::principal_access_boundary_policies::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
///
/// `PrincipalAccessBoundaryPolicies` holds a connection pool internally, it is advised to
/// create one and the reuse it.  You do not need to wrap `PrincipalAccessBoundaryPolicies` 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 PrincipalAccessBoundaryPolicies {
    inner: std::sync::Arc<dyn super::stub::dynamic::PrincipalAccessBoundaryPolicies>,
}

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

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

    /// Creates a principal access boundary policy, and returns a long running
    /// operation.
    ///
    /// # 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_principal_access_boundary_policy(
        &self,
    ) -> super::builder::principal_access_boundary_policies::CreatePrincipalAccessBoundaryPolicy
    {
        super::builder::principal_access_boundary_policies::CreatePrincipalAccessBoundaryPolicy::new(
            self.inner.clone(),
        )
    }

    /// Gets a principal access boundary policy.
    pub fn get_principal_access_boundary_policy(
        &self,
    ) -> super::builder::principal_access_boundary_policies::GetPrincipalAccessBoundaryPolicy {
        super::builder::principal_access_boundary_policies::GetPrincipalAccessBoundaryPolicy::new(
            self.inner.clone(),
        )
    }

    /// Updates a principal access boundary policy.
    ///
    /// # 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_principal_access_boundary_policy(
        &self,
    ) -> super::builder::principal_access_boundary_policies::UpdatePrincipalAccessBoundaryPolicy
    {
        super::builder::principal_access_boundary_policies::UpdatePrincipalAccessBoundaryPolicy::new(
            self.inner.clone(),
        )
    }

    /// Deletes a principal access boundary policy.
    ///
    /// # 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_principal_access_boundary_policy(
        &self,
    ) -> super::builder::principal_access_boundary_policies::DeletePrincipalAccessBoundaryPolicy
    {
        super::builder::principal_access_boundary_policies::DeletePrincipalAccessBoundaryPolicy::new(
            self.inner.clone(),
        )
    }

    /// Lists principal access boundary policies.
    pub fn list_principal_access_boundary_policies(
        &self,
    ) -> super::builder::principal_access_boundary_policies::ListPrincipalAccessBoundaryPolicies
    {
        super::builder::principal_access_boundary_policies::ListPrincipalAccessBoundaryPolicies::new(
            self.inner.clone(),
        )
    }

    /// Returns all policy bindings that bind a specific policy if a user has
    /// searchPolicyBindings permission on that policy.
    pub fn search_principal_access_boundary_policy_bindings(&self) -> super::builder::principal_access_boundary_policies::SearchPrincipalAccessBoundaryPolicyBindings
    {
        super::builder::principal_access_boundary_policies::SearchPrincipalAccessBoundaryPolicyBindings::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::principal_access_boundary_policies::GetOperation {
        super::builder::principal_access_boundary_policies::GetOperation::new(self.inner.clone())
    }
}