google_maps_fleetengine_v1/

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 Local Rides and Deliveries API.
///
/// # Example
/// ```
/// # use google_maps_fleetengine_v1::client::TripService;
/// async fn sample(
///    provider_id: &str,
///    trip_id: &str,
/// ) -> anyhow::Result<()> {
///     let client = TripService::builder().build().await?;
///     let response = client.get_trip()
///         .set_name(format!("providers/{provider_id}/trips/{trip_id}"))
///         .send().await?;
///     println!("response {:?}", response);
///     Ok(())
/// }
/// ```
///
/// # Service Description
///
/// Trip management service.
///
/// # Configuration
///
/// To configure `TripService` use the `with_*` methods in the type returned
/// by [builder()][TripService::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://fleetengine.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::trip_service::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::trip_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
///
/// `TripService` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `TripService` 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 TripService {
    inner: std::sync::Arc<dyn super::stub::dynamic::TripService>,
}

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

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

    /// Creates a trip in the Fleet Engine and returns the new trip.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_v1::client::TripService;
    /// use google_maps_fleetengine_v1::model::Trip;
    /// use google_maps_fleetengine_v1::Result;
    /// async fn sample(
    ///    client: &TripService, provider_id: &str, trip_id: &str
    /// ) -> Result<()> {
    ///     let response = client.create_trip()
    ///         .set_parent(format!("providers/{provider_id}/trips/{trip_id}"))
    ///         .set_trip_id("trip_id_value")
    ///         .set_trip(
    ///             Trip::new()/* set fields */
    ///         )
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_trip(&self) -> super::builder::trip_service::CreateTrip {
        super::builder::trip_service::CreateTrip::new(self.inner.clone())
    }

    /// Get information about a single trip.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_v1::client::TripService;
    /// use google_maps_fleetengine_v1::Result;
    /// async fn sample(
    ///    client: &TripService, provider_id: &str, trip_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_trip()
    ///         .set_name(format!("providers/{provider_id}/trips/{trip_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_trip(&self) -> super::builder::trip_service::GetTrip {
        super::builder::trip_service::GetTrip::new(self.inner.clone())
    }

    /// Deletes a single Trip.
    ///
    /// Returns FAILED_PRECONDITION if the Trip is active and assigned to a
    /// vehicle.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_v1::client::TripService;
    /// use google_maps_fleetengine_v1::Result;
    /// async fn sample(
    ///    client: &TripService, provider_id: &str, trip_id: &str
    /// ) -> Result<()> {
    ///     client.delete_trip()
    ///         .set_name(format!("providers/{provider_id}/trips/{trip_id}"))
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_trip(&self) -> super::builder::trip_service::DeleteTrip {
        super::builder::trip_service::DeleteTrip::new(self.inner.clone())
    }

    /// Report billable trip usage.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_v1::client::TripService;
    /// use google_maps_fleetengine_v1::Result;
    /// async fn sample(
    ///    client: &TripService
    /// ) -> Result<()> {
    ///     client.report_billable_trip()
    ///         /* set fields */
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn report_billable_trip(&self) -> super::builder::trip_service::ReportBillableTrip {
        super::builder::trip_service::ReportBillableTrip::new(self.inner.clone())
    }

    /// Get all the trips for a specific vehicle.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_v1::client::TripService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_maps_fleetengine_v1::Result;
    /// async fn sample(
    ///    client: &TripService
    /// ) -> Result<()> {
    ///     let mut list = client.search_trips()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn search_trips(&self) -> super::builder::trip_service::SearchTrips {
        super::builder::trip_service::SearchTrips::new(self.inner.clone())
    }

    /// Updates trip data.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_v1::client::TripService;
    /// # extern crate wkt as google_cloud_wkt;
    /// use google_cloud_wkt::FieldMask;
    /// use google_maps_fleetengine_v1::model::Trip;
    /// use google_maps_fleetengine_v1::Result;
    /// async fn sample(
    ///    client: &TripService, provider_id: &str, trip_id: &str
    /// ) -> Result<()> {
    ///     let response = client.update_trip()
    ///         .set_trip(
    ///             Trip::new().set_name(format!("providers/{provider_id}/trips/{trip_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_trip(&self) -> super::builder::trip_service::UpdateTrip {
        super::builder::trip_service::UpdateTrip::new(self.inner.clone())
    }
}

/// Implements a client for the Local Rides and Deliveries API.
///
/// # Example
/// ```
/// # use google_maps_fleetengine_v1::client::VehicleService;
/// use google_cloud_gax::paginator::ItemPaginator as _;
/// async fn sample(
///    parent: &str,
/// ) -> anyhow::Result<()> {
///     let client = VehicleService::builder().build().await?;
///     let mut list = client.list_vehicles()
///         .set_parent(parent)
///         .by_item();
///     while let Some(item) = list.next().await.transpose()? {
///         println!("{:?}", item);
///     }
///     Ok(())
/// }
/// ```
///
/// # Service Description
///
/// Vehicle management service.
///
/// # Configuration
///
/// To configure `VehicleService` use the `with_*` methods in the type returned
/// by [builder()][VehicleService::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://fleetengine.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::vehicle_service::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::vehicle_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
///
/// `VehicleService` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `VehicleService` 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 VehicleService {
    inner: std::sync::Arc<dyn super::stub::dynamic::VehicleService>,
}

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

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

    /// Instantiates a new vehicle associated with an on-demand rideshare or
    /// deliveries provider. Each `Vehicle` must have a unique vehicle ID.
    ///
    /// The following `Vehicle` fields are required when creating a `Vehicle`:
    ///
    /// * `vehicleState`
    /// * `supportedTripTypes`
    /// * `maximumCapacity`
    /// * `vehicleType`
    ///
    /// The following `Vehicle` fields are ignored when creating a `Vehicle`:
    ///
    /// * `name`
    /// * `currentTrips`
    /// * `availableCapacity`
    /// * `current_route_segment`
    /// * `current_route_segment_end_point`
    /// * `current_route_segment_version`
    /// * `current_route_segment_traffic`
    /// * `route`
    /// * `waypoints`
    /// * `waypoints_version`
    /// * `remaining_distance_meters`
    /// * `remaining_time_seconds`
    /// * `eta_to_next_waypoint`
    /// * `navigation_status`
    ///
    /// All other fields are optional and used if provided.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_v1::client::VehicleService;
    /// use google_maps_fleetengine_v1::model::Vehicle;
    /// use google_maps_fleetengine_v1::Result;
    /// async fn sample(
    ///    client: &VehicleService, parent: &str
    /// ) -> Result<()> {
    ///     let response = client.create_vehicle()
    ///         .set_parent(parent)
    ///         .set_vehicle_id("vehicle_id_value")
    ///         .set_vehicle(
    ///             Vehicle::new()/* set fields */
    ///         )
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_vehicle(&self) -> super::builder::vehicle_service::CreateVehicle {
        super::builder::vehicle_service::CreateVehicle::new(self.inner.clone())
    }

    /// Returns a vehicle from the Fleet Engine.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_v1::client::VehicleService;
    /// use google_maps_fleetengine_v1::Result;
    /// async fn sample(
    ///    client: &VehicleService, provider_id: &str, vehicle_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_vehicle()
    ///         .set_name(format!("providers/{provider_id}/vehicles/{vehicle_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_vehicle(&self) -> super::builder::vehicle_service::GetVehicle {
        super::builder::vehicle_service::GetVehicle::new(self.inner.clone())
    }

    /// Deletes a Vehicle from the Fleet Engine.
    ///
    /// Returns FAILED_PRECONDITION if the Vehicle has active Trips.
    /// assigned to it.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_v1::client::VehicleService;
    /// use google_maps_fleetengine_v1::Result;
    /// async fn sample(
    ///    client: &VehicleService, provider_id: &str, vehicle_id: &str
    /// ) -> Result<()> {
    ///     client.delete_vehicle()
    ///         .set_name(format!("providers/{provider_id}/vehicles/{vehicle_id}"))
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_vehicle(&self) -> super::builder::vehicle_service::DeleteVehicle {
        super::builder::vehicle_service::DeleteVehicle::new(self.inner.clone())
    }

    /// Writes updated vehicle data to the Fleet Engine.
    ///
    /// When updating a `Vehicle`, the following fields cannot be updated since
    /// they are managed by the server:
    ///
    /// * `currentTrips`
    /// * `availableCapacity`
    /// * `current_route_segment_version`
    /// * `waypoints_version`
    ///
    /// The vehicle `name` also cannot be updated.
    ///
    /// If the `attributes` field is updated, **all** the vehicle's attributes are
    /// replaced with the attributes provided in the request. If you want to update
    /// only some attributes, see the `UpdateVehicleAttributes` method. Likewise,
    /// the `waypoints` field can be updated, but must contain all the waypoints
    /// currently on the vehicle, and no other waypoints.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_v1::client::VehicleService;
    /// # extern crate wkt as google_cloud_wkt;
    /// use google_cloud_wkt::FieldMask;
    /// use google_maps_fleetengine_v1::model::Vehicle;
    /// use google_maps_fleetengine_v1::Result;
    /// async fn sample(
    ///    client: &VehicleService, provider_id: &str, vehicle_id: &str
    /// ) -> Result<()> {
    ///     let response = client.update_vehicle()
    ///         .set_vehicle(
    ///             Vehicle::new().set_name(format!("providers/{provider_id}/vehicles/{vehicle_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_vehicle(&self) -> super::builder::vehicle_service::UpdateVehicle {
        super::builder::vehicle_service::UpdateVehicle::new(self.inner.clone())
    }

    /// Partially updates a vehicle's attributes.
    /// Only the attributes mentioned in the request will be updated, other
    /// attributes will NOT be altered. Note: this is different in `UpdateVehicle`,
    /// where the whole `attributes` field will be replaced by the one in
    /// `UpdateVehicleRequest`, attributes not in the request would be removed.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_v1::client::VehicleService;
    /// use google_maps_fleetengine_v1::Result;
    /// async fn sample(
    ///    client: &VehicleService
    /// ) -> Result<()> {
    ///     let response = client.update_vehicle_attributes()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn update_vehicle_attributes(
        &self,
    ) -> super::builder::vehicle_service::UpdateVehicleAttributes {
        super::builder::vehicle_service::UpdateVehicleAttributes::new(self.inner.clone())
    }

    /// Returns a paginated list of vehicles associated with
    /// a provider that match the request options.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_v1::client::VehicleService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_maps_fleetengine_v1::Result;
    /// async fn sample(
    ///    client: &VehicleService, parent: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_vehicles()
    ///         .set_parent(parent)
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_vehicles(&self) -> super::builder::vehicle_service::ListVehicles {
        super::builder::vehicle_service::ListVehicles::new(self.inner.clone())
    }

    /// Returns a list of vehicles that match the request options.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_v1::client::VehicleService;
    /// use google_maps_fleetengine_v1::Result;
    /// async fn sample(
    ///    client: &VehicleService
    /// ) -> Result<()> {
    ///     let response = client.search_vehicles()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn search_vehicles(&self) -> super::builder::vehicle_service::SearchVehicles {
        super::builder::vehicle_service::SearchVehicles::new(self.inner.clone())
    }
}