google_maps_geocode_v4/

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

/// Implements a client for the Geocoding API.
///
/// # Example
/// ```
/// # use google_maps_geocode_v4::client::DestinationService;
/// async fn sample(
/// ) -> anyhow::Result<()> {
///     let client = DestinationService::builder().build().await?;
///     let response = client.search_destinations()
///         /* set fields */
///         .send().await?;
///     println!("response {:?}", response);
///     Ok(())
/// }
/// ```
///
/// # Service Description
///
/// A service for retrieving destinations.
///
/// A destination provides hierarchical context about a place, which
/// allows you to, for example, find apartment buildings within a larger
/// apartment complex and vice versa. It also provides navigation points suitable
/// for use cases such as ridesharing or delivery.
///
/// # Configuration
///
/// To configure `DestinationService` use the `with_*` methods in the type returned
/// by [builder()][DestinationService::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://geocoding-backend.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::destination_service::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::destination_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
///
/// `DestinationService` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `DestinationService` 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 DestinationService {
    inner: std::sync::Arc<dyn super::stub::dynamic::DestinationService>,
}

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

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

    /// This method performs a destination lookup and returns a list of
    /// destinations.
    ///
    /// # Example
    /// ```
    /// # use google_maps_geocode_v4::client::DestinationService;
    /// use google_maps_geocode_v4::Result;
    /// async fn sample(
    ///    client: &DestinationService
    /// ) -> Result<()> {
    ///     let response = client.search_destinations()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn search_destinations(&self) -> super::builder::destination_service::SearchDestinations {
        super::builder::destination_service::SearchDestinations::new(self.inner.clone())
    }
}

/// Implements a client for the Geocoding API.
///
/// # Example
/// ```
/// # use google_maps_geocode_v4::client::GeocodeService;
/// async fn sample(
/// ) -> anyhow::Result<()> {
///     let client = GeocodeService::builder().build().await?;
///     let response = client.geocode_address()
///         /* set fields */
///         .send().await?;
///     println!("response {:?}", response);
///     Ok(())
/// }
/// ```
///
/// # Service Description
///
/// A service for performing geocoding.
///
/// # Configuration
///
/// To configure `GeocodeService` use the `with_*` methods in the type returned
/// by [builder()][GeocodeService::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://geocoding-backend.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::geocode_service::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::geocode_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
///
/// `GeocodeService` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `GeocodeService` 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 GeocodeService {
    inner: std::sync::Arc<dyn super::stub::dynamic::GeocodeService>,
}

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

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

    /// This method performs an address geocode, which maps an address to a
    /// LatLng. It also provides structured information about the address.
    ///
    /// # Example
    /// ```
    /// # use google_maps_geocode_v4::client::GeocodeService;
    /// use google_maps_geocode_v4::Result;
    /// async fn sample(
    ///    client: &GeocodeService
    /// ) -> Result<()> {
    ///     let response = client.geocode_address()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn geocode_address(&self) -> super::builder::geocode_service::GeocodeAddress {
        super::builder::geocode_service::GeocodeAddress::new(self.inner.clone())
    }

    /// This method performs a location geocode, which maps a LatLng to an
    /// address. It also provides structured information about the address.
    ///
    /// # Example
    /// ```
    /// # use google_maps_geocode_v4::client::GeocodeService;
    /// use google_maps_geocode_v4::Result;
    /// async fn sample(
    ///    client: &GeocodeService
    /// ) -> Result<()> {
    ///     let response = client.geocode_location()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn geocode_location(&self) -> super::builder::geocode_service::GeocodeLocation {
        super::builder::geocode_service::GeocodeLocation::new(self.inner.clone())
    }

    /// This method performs a geocode lookup using a place ID.
    ///
    /// # Example
    /// ```
    /// # use google_maps_geocode_v4::client::GeocodeService;
    /// use google_maps_geocode_v4::Result;
    /// async fn sample(
    ///    client: &GeocodeService
    /// ) -> Result<()> {
    ///     let response = client.geocode_place()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn geocode_place(&self) -> super::builder::geocode_service::GeocodePlace {
        super::builder::geocode_service::GeocodePlace::new(self.inner.clone())
    }
}