Struct google_api_proto::maps::fleetengine::delivery::v1::DeliveryVehicle

pub struct DeliveryVehicle {
    pub name: String,
    pub last_location: Option<DeliveryVehicleLocation>,
    pub navigation_status: i32,
    pub current_route_segment: Bytes,
    pub current_route_segment_end_point: Option<LatLng>,
    pub remaining_distance_meters: Option<i32>,
    pub remaining_duration: Option<Duration>,
    pub remaining_vehicle_journey_segments: Vec<VehicleJourneySegment>,
    pub attributes: Vec<DeliveryVehicleAttribute>,
    pub type: i32,
}

The DeliveryVehicle message. A delivery vehicle transports shipments from a depot to a delivery location, and from a pickup location to the depot. In some cases, delivery vehicles also transport shipments directly from the pickup location to the delivery location.

Note: gRPC and REST APIs use different field naming conventions. For example, the DeliveryVehicle.current_route_segment field in the gRPC API and the DeliveryVehicle.currentRouteSegment field in the REST API refer to the same field.

Fields

name: String

The unique name of this Delivery Vehicle. The format is providers/{provider}/deliveryVehicles/{vehicle}.

last_location: Option<DeliveryVehicleLocation>

The last reported location of the Delivery Vehicle.

navigation_status: i32

The Delivery Vehicle’s navigation status.

current_route_segment: Bytes

The encoded polyline specifying the route that the navigation recommends taking to the next waypoint. Your driver app updates this when a stop is reached or passed, and when the navigation reroutes. These LatLngs are returned in Task.journey_sharing_info.remaining_vehicle_journey_segments\[0\].path (gRPC) or Task.journeySharingInfo.remainingVehicleJourneySegments\[0\].path (REST) for all active Tasks assigned to the Vehicle.

There are a few cases where this field might not be used to populate Task.journey_sharing_info.remaining_vehicle_journey_segments\[0\].path (gRPC) or Task.journeySharingInfo.remainingVehicleJourneySegments\[0\].path (REST):

• The endpoint of the current_route_segment does not match DeliveryVehicle.remaining_vehicle_journey_segments\[0\].stop (gRPC) or DeliveryVehicle.remainingVehicleJourneySegments\[0\].stop (REST).

• The driver app has not updated its location recently, so the last updated value for this field might be stale.

• The driver app has recently updated its location, but the current_route_segment is stale, and points to a previous vehicle stop.

In these cases, Fleet Engine populates this field with a route from the most recently passed VehicleStop to the upcoming VehicleStop to ensure that the consumer of this field has the best available information on the current path of the Delivery Vehicle.

current_route_segment_end_point: Option<LatLng>

The location where the current_route_segment ends. This is not currently populated by the driver app, but you can supply it on UpdateDeliveryVehicle calls. It is either the LatLng from the upcoming vehicle stop, or the last LatLng of the current_route_segment. Fleet Engine will then do its best to interpolate to an actual VehicleStop.

This field is ignored in UpdateDeliveryVehicle calls if the current_route_segment field is empty.

remaining_distance_meters: Option<i32>

The remaining driving distance for the current_route_segment. The Driver app typically provides this field, but there are some circumstances in which Fleet Engine will override the value sent by the app. For more information, see [DeliveryVehicle.current_route_segment][maps.fleetengine.delivery.v1.DeliveryVehicle.current_route_segment]. This field is returned in Task.remaining_vehicle_journey_segments\[0\].driving_distance_meters (gRPC) or Task.remainingVehicleJourneySegments\[0\].drivingDistanceMeters (REST) for all active Tasks assigned to the Delivery Vehicle.

Fleet Engine ignores this field in UpdateDeliveryVehicleRequest if the current_route_segment field is empty.

remaining_duration: Option<Duration>

The remaining driving time for the current_route_segment. The Driver app typically provides this field, but there are some circumstances in which Fleet Engine will override the value sent by the app. For more information, see [DeliveryVehicle.current_route_segment][maps.fleetengine.delivery.v1.DeliveryVehicle.current_route_segment]. This field is returned in Task.remaining_vehicle_journey_segments\[0\].driving_duration (gRPC) or Task.remainingVehicleJourneySegments\[0\].drivingDuration (REST) for all active tasks assigned to the Delivery Vehicle.

Fleet Engine ignores this field in UpdateDeliveryVehicleRequest if the current_route_segment field is empty.

remaining_vehicle_journey_segments: Vec<VehicleJourneySegment>

The journey segments assigned to this Delivery Vehicle, starting from the Vehicle’s most recently reported location. This field won’t be populated in the response of ListDeliveryVehicles.

attributes: Vec<DeliveryVehicleAttribute>

A list of custom Delivery Vehicle attributes. A Delivery Vehicle can have at most 100 attributes, and each attribute must have a unique key.

type: i32

The type of this delivery vehicle. If unset, this will default to AUTO.

Implementations

impl DeliveryVehicle

pub fn navigation_status(&self) -> DeliveryVehicleNavigationStatus

Returns the enum value of navigation_status, or the default if the field is set to an invalid enum value.

pub fn set_navigation_status(&mut self, value: DeliveryVehicleNavigationStatus)

Sets navigation_status to the provided enum value.

pub fn type(&self) -> DeliveryVehicleType

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: DeliveryVehicleType)

Sets type to the provided enum value.

Trait Implementations

impl Clone for DeliveryVehicle

fn clone(&self) -> DeliveryVehicle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeliveryVehicle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DeliveryVehicle

fn default() -> Self

Returns the “default value” for a type.

impl Message for DeliveryVehicle

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for DeliveryVehicle

fn eq(&self, other: &DeliveryVehicle) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DeliveryVehicle