google-cloud-agentidentity-v1 1.1.0

// 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::bare_urls)]
#![allow(rustdoc::broken_intra_doc_links)]
#![allow(rustdoc::invalid_html_tags)]
#![allow(rustdoc::redundant_explicit_links)]

/// Implements a client for the Agent Identity API.
///
/// # Example
/// ```
/// # use google_cloud_agentidentity_v1::client::AuthProviderService;
/// use google_cloud_gax::paginator::ItemPaginator as _;
/// async fn sample(
///    project_id: &str,
///    location_id: &str,
/// ) -> anyhow::Result<()> {
///     let client = AuthProviderService::builder().build().await?;
///     let mut list = client.list_auth_providers()
///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
///         .by_item();
///     while let Some(item) = list.next().await.transpose()? {
///         println!("{:?}", item);
///     }
///     Ok(())
/// }
/// ```
///
/// # Service Description
///
/// Service describing handlers for resources
///
/// # Configuration
///
/// To configure `AuthProviderService` use the `with_*` methods in the type returned
/// by [builder()][AuthProviderService::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://agentidentity.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::auth_provider_service::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::auth_provider_service::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
///
/// `AuthProviderService` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `AuthProviderService` 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 AuthProviderService {
    inner: std::sync::Arc<dyn super::stub::dynamic::AuthProviderService>,
}

impl AuthProviderService {
    /// Returns a builder for [AuthProviderService].
    ///
    /// ```
    /// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// let client = AuthProviderService::builder().build().await?;
    /// # Ok(()) }
    /// ```
    pub fn builder() -> super::builder::auth_provider_service::ClientBuilder {
        crate::new_client_builder(super::builder::auth_provider_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: impl Into<std::sync::Arc<T>>) -> Self
    where
        T: super::stub::AuthProviderService + 'static,
    {
        Self { inner: stub.into() }
    }

    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::AuthProviderService>>
    {
        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::AuthProviderService> {
        super::transport::AuthProviderService::new(conf).await
    }

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

    /// Lists AuthProviders in a given project and location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_auth_providers()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_auth_providers(&self) -> super::builder::auth_provider_service::ListAuthProviders {
        super::builder::auth_provider_service::ListAuthProviders::new(self.inner.clone())
    }

    /// Gets details of a single AuthProvider.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService, project_id: &str, location_id: &str, auth_provider_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_auth_provider()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/authProviders/{auth_provider_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_auth_provider(&self) -> super::builder::auth_provider_service::GetAuthProvider {
        super::builder::auth_provider_service::GetAuthProvider::new(self.inner.clone())
    }

    /// Creates a new AuthProvider in a given project and location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::model::AuthProvider;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let response = client.create_auth_provider()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
    ///         .set_auth_provider(
    ///             AuthProvider::new()/* set fields */
    ///         )
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_auth_provider(
        &self,
    ) -> super::builder::auth_provider_service::CreateAuthProvider {
        super::builder::auth_provider_service::CreateAuthProvider::new(self.inner.clone())
    }

    /// Updates the parameters of a single AuthProvider.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// # extern crate wkt as google_cloud_wkt;
    /// use google_cloud_wkt::FieldMask;
    /// use google_cloud_agentidentity_v1::model::AuthProvider;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService, project_id: &str, location_id: &str, auth_provider_id: &str
    /// ) -> Result<()> {
    ///     let response = client.update_auth_provider()
    ///         .set_auth_provider(
    ///             AuthProvider::new().set_name(format!("projects/{project_id}/locations/{location_id}/authProviders/{auth_provider_id}"))/* set fields */
    ///         )
    ///         .set_update_mask(FieldMask::default().set_paths(["updated.field.path1", "updated.field.path2"]))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn update_auth_provider(
        &self,
    ) -> super::builder::auth_provider_service::UpdateAuthProvider {
        super::builder::auth_provider_service::UpdateAuthProvider::new(self.inner.clone())
    }

    /// Deletes a single AuthProvider.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService, project_id: &str, location_id: &str, auth_provider_id: &str
    /// ) -> Result<()> {
    ///     client.delete_auth_provider()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/authProviders/{auth_provider_id}"))
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_auth_provider(
        &self,
    ) -> super::builder::auth_provider_service::DeleteAuthProvider {
        super::builder::auth_provider_service::DeleteAuthProvider::new(self.inner.clone())
    }

    /// Undeletes a single AuthProvider.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService, project_id: &str, location_id: &str, auth_provider_id: &str
    /// ) -> Result<()> {
    ///     let response = client.undelete_auth_provider()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/authProviders/{auth_provider_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn undelete_auth_provider(
        &self,
    ) -> super::builder::auth_provider_service::UndeleteAuthProvider {
        super::builder::auth_provider_service::UndeleteAuthProvider::new(self.inner.clone())
    }

    /// Queries what all auth_providers are used by a given workload_id.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService
    /// ) -> Result<()> {
    ///     let response = client.query_auth_providers()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn query_auth_providers(
        &self,
    ) -> super::builder::auth_provider_service::QueryAuthProviders {
        super::builder::auth_provider_service::QueryAuthProviders::new(self.inner.clone())
    }

    /// Queries what all workloads are using a given auth_provider.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService
    /// ) -> Result<()> {
    ///     let response = client.query_workloads()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn query_workloads(&self) -> super::builder::auth_provider_service::QueryWorkloads {
        super::builder::auth_provider_service::QueryWorkloads::new(self.inner.clone())
    }

    /// Lists Authorizations in a given project and location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService, project_id: &str, location_id: &str, auth_provider_id: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_authorizations()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}/authProviders/{auth_provider_id}"))
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_authorizations(&self) -> super::builder::auth_provider_service::ListAuthorizations {
        super::builder::auth_provider_service::ListAuthorizations::new(self.inner.clone())
    }

    /// Gets details of a single Authorization.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService, project_id: &str, location_id: &str, auth_provider_id: &str, authorization_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_authorization()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/authProviders/{auth_provider_id}/authorizations/{authorization_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_authorization(&self) -> super::builder::auth_provider_service::GetAuthorization {
        super::builder::auth_provider_service::GetAuthorization::new(self.inner.clone())
    }

    /// Deletes a single Authorization.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService, project_id: &str, location_id: &str, auth_provider_id: &str, authorization_id: &str
    /// ) -> Result<()> {
    ///     client.delete_authorization()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/authProviders/{auth_provider_id}/authorizations/{authorization_id}"))
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_authorization(
        &self,
    ) -> super::builder::auth_provider_service::DeleteAuthorization {
        super::builder::auth_provider_service::DeleteAuthorization::new(self.inner.clone())
    }

    /// Lists AccessSummaries in a given project and location.
    /// Supported Filters:
    ///
    /// - `workload_id`: Filter by the SPIFFE ID of the agent.
    ///   Example: `workload_id="spiffe://example.com/ns/default/sa/my-agent"`
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_access_summaries()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_access_summaries(
        &self,
    ) -> super::builder::auth_provider_service::ListAccessSummaries {
        super::builder::auth_provider_service::ListAccessSummaries::new(self.inner.clone())
    }

    /// Gets details of a single AccessSummary.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService, project_id: &str, location_id: &str, access_summary_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_access_summary()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/accessSummaries/{access_summary_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_access_summary(&self) -> super::builder::auth_provider_service::GetAccessSummary {
        super::builder::auth_provider_service::GetAccessSummary::new(self.inner.clone())
    }

    /// Revokes all authorizations for a specific user on an AuthProvider.
    /// This deletes all authorization records associated with the user and
    /// AuthProvider, effectively revoking access across all agents.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService
    /// ) -> Result<()> {
    ///     let response = client.revoke_authorization()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn revoke_authorization(
        &self,
    ) -> super::builder::auth_provider_service::RevokeAuthorization {
        super::builder::auth_provider_service::RevokeAuthorization::new(self.inner.clone())
    }

    /// Enables a single AuthProvider.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService
    /// ) -> Result<()> {
    ///     let response = client.enable_auth_provider()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn enable_auth_provider(
        &self,
    ) -> super::builder::auth_provider_service::EnableAuthProvider {
        super::builder::auth_provider_service::EnableAuthProvider::new(self.inner.clone())
    }

    /// Disables a single AuthProvider.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService
    /// ) -> Result<()> {
    ///     let response = client.disable_auth_provider()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn disable_auth_provider(
        &self,
    ) -> super::builder::auth_provider_service::DisableAuthProvider {
        super::builder::auth_provider_service::DisableAuthProvider::new(self.inner.clone())
    }

    /// Lists information about the supported locations for this service.
    ///
    /// This method lists locations based on the resource scope provided in
    /// the [ListLocationsRequest.name][google.cloud.location.ListLocationsRequest.name] field: *
    /// **Global locations**: If `name` is empty, the method lists the
    /// public locations available to all projects. * **Project-specific
    /// locations**: If `name` follows the format
    /// `projects/{project}`, the method lists locations visible to that
    /// specific project. This includes public, private, or other
    /// project-specific locations enabled for the project.
    ///
    /// For gRPC and client library implementations, the resource name is
    /// passed as the `name` field. For direct service calls, the resource
    /// name is
    /// incorporated into the request path based on the specific service
    /// implementation and version.
    ///
    /// [google.cloud.location.ListLocationsRequest.name]: google_cloud_location::model::ListLocationsRequest::name
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService
    /// ) -> Result<()> {
    ///     let mut list = client.list_locations()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_locations(&self) -> super::builder::auth_provider_service::ListLocations {
        super::builder::auth_provider_service::ListLocations::new(self.inner.clone())
    }

    /// Gets information about a location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService
    /// ) -> Result<()> {
    ///     let response = client.get_location()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_location(&self) -> super::builder::auth_provider_service::GetLocation {
        super::builder::auth_provider_service::GetLocation::new(self.inner.clone())
    }

    /// Sets the access control policy on the specified resource. Replaces
    /// any existing policy.
    ///
    /// Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
    /// errors.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService
    /// ) -> Result<()> {
    ///     let response = client.set_iam_policy()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn set_iam_policy(&self) -> super::builder::auth_provider_service::SetIamPolicy {
        super::builder::auth_provider_service::SetIamPolicy::new(self.inner.clone())
    }

    /// Gets the access control policy for a resource. Returns an empty policy
    /// if the resource exists and does not have a policy set.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService
    /// ) -> Result<()> {
    ///     let response = client.get_iam_policy()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_iam_policy(&self) -> super::builder::auth_provider_service::GetIamPolicy {
        super::builder::auth_provider_service::GetIamPolicy::new(self.inner.clone())
    }

    /// Returns permissions that a caller has on the specified resource. If the
    /// resource does not exist, this will return an empty set of
    /// permissions, not a `NOT_FOUND` error.
    ///
    /// Note: This operation is designed to be used for building
    /// permission-aware UIs and command-line tools, not for authorization
    /// checking. This operation may "fail open" without warning.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_agentidentity_v1::client::AuthProviderService;
    /// use google_cloud_agentidentity_v1::Result;
    /// async fn sample(
    ///    client: &AuthProviderService
    /// ) -> Result<()> {
    ///     let response = client.test_iam_permissions()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn test_iam_permissions(
        &self,
    ) -> super::builder::auth_provider_service::TestIamPermissions {
        super::builder::auth_provider_service::TestIamPermissions::new(self.inner.clone())
    }
}