google-cloud-locationfinder-v1 1.10.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::bare_urls)]
#![allow(rustdoc::broken_intra_doc_links)]
#![allow(rustdoc::invalid_html_tags)]
#![allow(rustdoc::redundant_explicit_links)]

/// Implements a client for the Cloud Location Finder API.
///
/// # Example
/// ```
/// # use google_cloud_locationfinder_v1::client::CloudLocationFinder;
/// use google_cloud_gax::paginator::ItemPaginator as _;
/// async fn sample(
///    project_id: &str,
///    location_id: &str,
/// ) -> anyhow::Result<()> {
///     let client = CloudLocationFinder::builder().build().await?;
///     let mut list = client.list_cloud_locations()
///         .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 `CloudLocationFinder` use the `with_*` methods in the type returned
/// by [builder()][CloudLocationFinder::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://cloudlocationfinder.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_location_finder::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::cloud_location_finder::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
///
/// `CloudLocationFinder` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `CloudLocationFinder` 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 CloudLocationFinder {
    inner: std::sync::Arc<dyn super::stub::dynamic::CloudLocationFinder>,
}

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

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

    /// Lists cloud locations under a given project and location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_locationfinder_v1::client::CloudLocationFinder;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_locationfinder_v1::Result;
    /// async fn sample(
    ///    client: &CloudLocationFinder, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_cloud_locations()
    ///         .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_cloud_locations(
        &self,
    ) -> super::builder::cloud_location_finder::ListCloudLocations {
        super::builder::cloud_location_finder::ListCloudLocations::new(self.inner.clone())
    }

    /// Retrieves a resource containing information about a cloud location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_locationfinder_v1::client::CloudLocationFinder;
    /// use google_cloud_locationfinder_v1::Result;
    /// async fn sample(
    ///    client: &CloudLocationFinder, project_id: &str, location_id: &str, cloud_location_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_cloud_location()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/cloudLocations/{cloud_location_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_cloud_location(&self) -> super::builder::cloud_location_finder::GetCloudLocation {
        super::builder::cloud_location_finder::GetCloudLocation::new(self.inner.clone())
    }

    /// Searches for cloud locations from a given source location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_locationfinder_v1::client::CloudLocationFinder;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_locationfinder_v1::Result;
    /// async fn sample(
    ///    client: &CloudLocationFinder
    /// ) -> Result<()> {
    ///     let mut list = client.search_cloud_locations()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn search_cloud_locations(
        &self,
    ) -> super::builder::cloud_location_finder::SearchCloudLocations {
        super::builder::cloud_location_finder::SearchCloudLocations::new(self.inner.clone())
    }

    /// Lists information about the supported locations for this service.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_locationfinder_v1::client::CloudLocationFinder;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_locationfinder_v1::Result;
    /// async fn sample(
    ///    client: &CloudLocationFinder
    /// ) -> 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::cloud_location_finder::ListLocations {
        super::builder::cloud_location_finder::ListLocations::new(self.inner.clone())
    }

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