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

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

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

    /// Returns the current weather conditions at a given location.
    ///
    /// # Example
    /// ```
    /// # use google_maps_weather_v1::client::Weather;
    /// use google_maps_weather_v1::Result;
    /// async fn sample(
    ///    client: &Weather
    /// ) -> Result<()> {
    ///     let response = client.lookup_current_conditions()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn lookup_current_conditions(&self) -> super::builder::weather::LookupCurrentConditions {
        super::builder::weather::LookupCurrentConditions::new(self.inner.clone())
    }

    /// Returns up to 240 hours of hourly forecasts at a given location, starting
    /// from the current hour.
    ///
    /// # Example
    /// ```
    /// # use google_maps_weather_v1::client::Weather;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_maps_weather_v1::Result;
    /// async fn sample(
    ///    client: &Weather
    /// ) -> Result<()> {
    ///     let mut list = client.lookup_forecast_hours()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn lookup_forecast_hours(&self) -> super::builder::weather::LookupForecastHours {
        super::builder::weather::LookupForecastHours::new(self.inner.clone())
    }

    /// Returns up to 10 days of daily forecasts at a given location, starting from
    /// the current day.
    ///
    /// # Example
    /// ```
    /// # use google_maps_weather_v1::client::Weather;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_maps_weather_v1::Result;
    /// async fn sample(
    ///    client: &Weather
    /// ) -> Result<()> {
    ///     let mut list = client.lookup_forecast_days()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn lookup_forecast_days(&self) -> super::builder::weather::LookupForecastDays {
        super::builder::weather::LookupForecastDays::new(self.inner.clone())
    }

    /// Returns up to 24 hours of hourly historical weather data at a given
    /// location, starting from the last hour.
    ///
    /// # Example
    /// ```
    /// # use google_maps_weather_v1::client::Weather;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_maps_weather_v1::Result;
    /// async fn sample(
    ///    client: &Weather
    /// ) -> Result<()> {
    ///     let mut list = client.lookup_history_hours()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn lookup_history_hours(&self) -> super::builder::weather::LookupHistoryHours {
        super::builder::weather::LookupHistoryHours::new(self.inner.clone())
    }

    /// Returns public weather alerts for a given location.
    ///
    /// # Example
    /// ```
    /// # use google_maps_weather_v1::client::Weather;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_maps_weather_v1::Result;
    /// async fn sample(
    ///    client: &Weather
    /// ) -> Result<()> {
    ///     let mut list = client.lookup_public_alerts()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn lookup_public_alerts(&self) -> super::builder::weather::LookupPublicAlerts {
        super::builder::weather::LookupPublicAlerts::new(self.inner.clone())
    }

    /// Returns minute-level precipitation nowcast events for up to 6 hours.
    ///
    /// # Example
    /// ```
    /// # use google_maps_weather_v1::client::Weather;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_maps_weather_v1::Result;
    /// async fn sample(
    ///    client: &Weather
    /// ) -> Result<()> {
    ///     let mut list = client.lookup_forecast_minutes()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn lookup_forecast_minutes(&self) -> super::builder::weather::LookupForecastMinutes {
        super::builder::weather::LookupForecastMinutes::new(self.inner.clone())
    }
}