google-maps-fleetengine-delivery-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 Last Mile Fleet Solution Delivery API.
///
/// # Example
/// ```
/// # use google_maps_fleetengine_delivery_v1::client::DeliveryService;
/// use google_cloud_gax::paginator::ItemPaginator as _;
/// async fn sample(
///    provider_id: &str,
/// ) -> anyhow::Result<()> {
///     let client = DeliveryService::builder().build().await?;
///     let mut list = client.list_delivery_vehicles()
///         .set_parent(format!("providers/{provider_id}"))
///         .by_item();
///     while let Some(item) = list.next().await.transpose()? {
///         println!("{:?}", item);
///     }
///     Ok(())
/// }
/// ```
///
/// # Service Description
///
/// The Last Mile Delivery service.
///
/// # Configuration
///
/// To configure `DeliveryService` use the `with_*` methods in the type returned
/// by [builder()][DeliveryService::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::delivery_service::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::delivery_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
///
/// `DeliveryService` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `DeliveryService` 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 DeliveryService {
    inner: std::sync::Arc<dyn super::stub::dynamic::DeliveryService>,
}

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

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

    /// Creates and returns a new `DeliveryVehicle`.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_delivery_v1::client::DeliveryService;
    /// use google_maps_fleetengine_delivery_v1::model::DeliveryVehicle;
    /// use google_maps_fleetengine_delivery_v1::Result;
    /// async fn sample(
    ///    client: &DeliveryService, parent: &str
    /// ) -> Result<()> {
    ///     let response = client.create_delivery_vehicle()
    ///         .set_parent(parent)
    ///         .set_delivery_vehicle(
    ///             DeliveryVehicle::new()/* set fields */
    ///         )
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_delivery_vehicle(
        &self,
    ) -> super::builder::delivery_service::CreateDeliveryVehicle {
        super::builder::delivery_service::CreateDeliveryVehicle::new(self.inner.clone())
    }

    /// Returns the specified `DeliveryVehicle` instance.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_delivery_v1::client::DeliveryService;
    /// use google_maps_fleetengine_delivery_v1::Result;
    /// async fn sample(
    ///    client: &DeliveryService, provider_id: &str, vehicle_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_delivery_vehicle()
    ///         .set_name(format!("providers/{provider_id}/deliveryVehicles/{vehicle_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_delivery_vehicle(&self) -> super::builder::delivery_service::GetDeliveryVehicle {
        super::builder::delivery_service::GetDeliveryVehicle::new(self.inner.clone())
    }

    /// Deletes a DeliveryVehicle from the Fleet Engine.
    ///
    /// Returns FAILED_PRECONDITION if the DeliveryVehicle has OPEN Tasks
    /// assigned to it.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_delivery_v1::client::DeliveryService;
    /// use google_maps_fleetengine_delivery_v1::Result;
    /// async fn sample(
    ///    client: &DeliveryService, provider_id: &str, vehicle_id: &str
    /// ) -> Result<()> {
    ///     client.delete_delivery_vehicle()
    ///         .set_name(format!("providers/{provider_id}/deliveryVehicles/{vehicle_id}"))
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_delivery_vehicle(
        &self,
    ) -> super::builder::delivery_service::DeleteDeliveryVehicle {
        super::builder::delivery_service::DeleteDeliveryVehicle::new(self.inner.clone())
    }

    /// Writes updated `DeliveryVehicle` data to Fleet Engine, and assigns
    /// `Tasks` to the `DeliveryVehicle`. You cannot update the name of the
    /// `DeliveryVehicle`. You *can* update `remaining_vehicle_journey_segments`,
    /// but it must contain all of the `VehicleJourneySegment`s to be persisted on
    /// the `DeliveryVehicle`. The `task_id`s are retrieved from
    /// `remaining_vehicle_journey_segments`, and their corresponding `Tasks` are
    /// assigned to the `DeliveryVehicle` if they have not yet been assigned.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_delivery_v1::client::DeliveryService;
    /// # extern crate wkt as google_cloud_wkt;
    /// use google_cloud_wkt::FieldMask;
    /// use google_maps_fleetengine_delivery_v1::model::DeliveryVehicle;
    /// use google_maps_fleetengine_delivery_v1::Result;
    /// async fn sample(
    ///    client: &DeliveryService, provider_id: &str, vehicle_id: &str
    /// ) -> Result<()> {
    ///     let response = client.update_delivery_vehicle()
    ///         .set_delivery_vehicle(
    ///             DeliveryVehicle::new().set_name(format!("providers/{provider_id}/deliveryVehicles/{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_delivery_vehicle(
        &self,
    ) -> super::builder::delivery_service::UpdateDeliveryVehicle {
        super::builder::delivery_service::UpdateDeliveryVehicle::new(self.inner.clone())
    }

    /// Creates and returns a batch of new `Task` objects.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_delivery_v1::client::DeliveryService;
    /// use google_maps_fleetengine_delivery_v1::Result;
    /// async fn sample(
    ///    client: &DeliveryService
    /// ) -> Result<()> {
    ///     let response = client.batch_create_tasks()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn batch_create_tasks(&self) -> super::builder::delivery_service::BatchCreateTasks {
        super::builder::delivery_service::BatchCreateTasks::new(self.inner.clone())
    }

    /// Creates and returns a new `Task` object.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_delivery_v1::client::DeliveryService;
    /// use google_maps_fleetengine_delivery_v1::model::Task;
    /// use google_maps_fleetengine_delivery_v1::Result;
    /// async fn sample(
    ///    client: &DeliveryService, parent: &str
    /// ) -> Result<()> {
    ///     let response = client.create_task()
    ///         .set_parent(parent)
    ///         .set_task_id("task_id_value")
    ///         .set_task(
    ///             Task::new()/* set fields */
    ///         )
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_task(&self) -> super::builder::delivery_service::CreateTask {
        super::builder::delivery_service::CreateTask::new(self.inner.clone())
    }

    /// Gets information about a `Task`.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_delivery_v1::client::DeliveryService;
    /// use google_maps_fleetengine_delivery_v1::Result;
    /// async fn sample(
    ///    client: &DeliveryService, provider_id: &str, task_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_task()
    ///         .set_name(format!("providers/{provider_id}/tasks/{task_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_task(&self) -> super::builder::delivery_service::GetTask {
        super::builder::delivery_service::GetTask::new(self.inner.clone())
    }

    /// Deletes a single Task.
    ///
    /// Returns FAILED_PRECONDITION if the Task is OPEN and assigned to a
    /// DeliveryVehicle.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_delivery_v1::client::DeliveryService;
    /// use google_maps_fleetengine_delivery_v1::Result;
    /// async fn sample(
    ///    client: &DeliveryService, provider_id: &str, task_id: &str
    /// ) -> Result<()> {
    ///     client.delete_task()
    ///         .set_name(format!("providers/{provider_id}/tasks/{task_id}"))
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_task(&self) -> super::builder::delivery_service::DeleteTask {
        super::builder::delivery_service::DeleteTask::new(self.inner.clone())
    }

    /// Updates `Task` data.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_delivery_v1::client::DeliveryService;
    /// # extern crate wkt as google_cloud_wkt;
    /// use google_cloud_wkt::FieldMask;
    /// use google_maps_fleetengine_delivery_v1::model::Task;
    /// use google_maps_fleetengine_delivery_v1::Result;
    /// async fn sample(
    ///    client: &DeliveryService, provider_id: &str, task_id: &str
    /// ) -> Result<()> {
    ///     let response = client.update_task()
    ///         .set_task(
    ///             Task::new().set_name(format!("providers/{provider_id}/tasks/{task_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_task(&self) -> super::builder::delivery_service::UpdateTask {
        super::builder::delivery_service::UpdateTask::new(self.inner.clone())
    }

    /// Gets all `Task`s that meet the specified filtering criteria.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_delivery_v1::client::DeliveryService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_maps_fleetengine_delivery_v1::Result;
    /// async fn sample(
    ///    client: &DeliveryService, provider_id: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_tasks()
    ///         .set_parent(format!("providers/{provider_id}"))
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_tasks(&self) -> super::builder::delivery_service::ListTasks {
        super::builder::delivery_service::ListTasks::new(self.inner.clone())
    }

    /// Returns the specified `TaskTrackingInfo` instance.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_delivery_v1::client::DeliveryService;
    /// use google_maps_fleetengine_delivery_v1::Result;
    /// async fn sample(
    ///    client: &DeliveryService, provider_id: &str, tracking_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_task_tracking_info()
    ///         .set_name(format!("providers/{provider_id}/taskTrackingInfo/{tracking_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_task_tracking_info(&self) -> super::builder::delivery_service::GetTaskTrackingInfo {
        super::builder::delivery_service::GetTaskTrackingInfo::new(self.inner.clone())
    }

    /// Gets all `DeliveryVehicle`s that meet the specified filtering criteria.
    ///
    /// # Example
    /// ```
    /// # use google_maps_fleetengine_delivery_v1::client::DeliveryService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_maps_fleetengine_delivery_v1::Result;
    /// async fn sample(
    ///    client: &DeliveryService, provider_id: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_delivery_vehicles()
    ///         .set_parent(format!("providers/{provider_id}"))
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_delivery_vehicles(&self) -> super::builder::delivery_service::ListDeliveryVehicles {
        super::builder::delivery_service::ListDeliveryVehicles::new(self.inner.clone())
    }
}