google-maps-places-v1 1.0.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 Places API (New).
///
/// # Example
/// ```
/// # use google_maps_places_v1::client::Places;
/// async fn sample(
///    place_id: &str,
/// ) -> anyhow::Result<()> {
///     let client = Places::builder().build().await?;
///     let response = client.get_place()
///         .set_name(format!("places/{place_id}"))
///         .send().await?;
///     println!("response {:?}", response);
///     Ok(())
/// }
/// ```
///
/// # Service Description
///
/// Service definition for the Places API.
/// Note: every request (except for Autocomplete and GetPhotoMedia requests)
/// requires a field mask set outside of the request proto (`all/*`, is not
/// assumed). The field mask can be set via the HTTP header `X-Goog-FieldMask`.
/// See:
/// <https://developers.google.com/maps/documentation/places/web-service/choose-fields>
///
/// # Configuration
///
/// To configure `Places` use the `with_*` methods in the type returned
/// by [builder()][Places::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://places.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::places::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::places::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
///
/// `Places` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `Places` 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 Places {
    inner: std::sync::Arc<dyn super::stub::dynamic::Places>,
}

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

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

    /// Search for places near locations.
    ///
    /// # Example
    /// ```
    /// # use google_maps_places_v1::client::Places;
    /// use google_maps_places_v1::Result;
    /// async fn sample(
    ///    client: &Places
    /// ) -> Result<()> {
    ///     let response = client.search_nearby()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn search_nearby(&self) -> super::builder::places::SearchNearby {
        super::builder::places::SearchNearby::new(self.inner.clone())
    }

    /// Text query based place search.
    ///
    /// # Example
    /// ```
    /// # use google_maps_places_v1::client::Places;
    /// use google_maps_places_v1::Result;
    /// async fn sample(
    ///    client: &Places
    /// ) -> Result<()> {
    ///     let response = client.search_text()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn search_text(&self) -> super::builder::places::SearchText {
        super::builder::places::SearchText::new(self.inner.clone())
    }

    /// Get a photo media with a photo reference string.
    ///
    /// # Example
    /// ```
    /// # use google_maps_places_v1::client::Places;
    /// use google_maps_places_v1::Result;
    /// async fn sample(
    ///    client: &Places, place_id: &str, photo_reference_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_photo_media()
    ///         .set_name(format!("places/{place_id}/photos/{photo_reference_id}/media"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_photo_media(&self) -> super::builder::places::GetPhotoMedia {
        super::builder::places::GetPhotoMedia::new(self.inner.clone())
    }

    /// Get the details of a place based on its resource name, which is a string
    /// in the `places/{place_id}` format.
    ///
    /// # Example
    /// ```
    /// # use google_maps_places_v1::client::Places;
    /// use google_maps_places_v1::Result;
    /// async fn sample(
    ///    client: &Places, place_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_place()
    ///         .set_name(format!("places/{place_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_place(&self) -> super::builder::places::GetPlace {
        super::builder::places::GetPlace::new(self.inner.clone())
    }

    /// Returns predictions for the given input.
    ///
    /// # Example
    /// ```
    /// # use google_maps_places_v1::client::Places;
    /// use google_maps_places_v1::Result;
    /// async fn sample(
    ///    client: &Places
    /// ) -> Result<()> {
    ///     let response = client.autocomplete_places()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn autocomplete_places(&self) -> super::builder::places::AutocompletePlaces {
        super::builder::places::AutocompletePlaces::new(self.inner.clone())
    }
}