Struct googapis::maps::fleetengine::v1::Vehicle

pub struct Vehicle {

    pub name: String,
    pub vehicle_state: i32,
    pub supported_trip_types: Vec<i32>,
    pub current_trips: Vec<String>,
    pub last_location: Option<VehicleLocation>,
    pub maximum_capacity: i32,
    pub available_capacity: i32,
    pub attributes: Vec<VehicleAttribute>,
    pub vehicle_type: Option<VehicleType>,
    pub license_plate: Option<LicensePlate>,
    pub route: Vec<TerminalLocation>,
    pub current_route_segment: String,
    pub current_route_segment_version: Option<Timestamp>,
    pub current_route_segment_end_point: Option<TripWaypoint>,
    pub remaining_distance_meters: Option<i32>,
    pub eta_to_first_waypoint: Option<Timestamp>,
    pub remaining_time_seconds: Option<i32>,
    pub waypoints: Vec<TripWaypoint>,
    pub waypoints_version: Option<Timestamp>,
    pub back_to_back_enabled: bool,
    pub navigation_status: i32,
    pub device_settings: Option<DeviceSettings>,
}

Vehicle metadata.

Fields

name: String

The unique name for this vehicle. The format is providers/{provider}/vehicles/{vehicle}

vehicle_state: i32

The vehicle state.

supported_trip_types: Vec<i32>

Supported trip types.

current_trips: Vec<String>

List of IDs for trips in progress.

last_location: Option<VehicleLocation>

Last reported location of the vehicle.

maximum_capacity: i32

Maximum capacity of the vehicle. This is the total numbers of riders on trips this vehicle can contain. The driver is not considered in this value. This value must be greater than or equal to one.

available_capacity: i32

The current available capacity of the vehicle. This is the maximum_capacity minus the current number of riders.

attributes: Vec<VehicleAttribute>

List of vehicle service attributes.

vehicle_type: Option<VehicleType>

The type of this Vehicle. Can be filtered during SearchVehicles. Also influences ETA and route calculations.

license_plate: Option<LicensePlate>

License plate information for the vehicle.

route: Vec<TerminalLocation>

👎 Deprecated

Deprecated. Use vehicle.waypoint instead.

current_route_segment: String

The polyline specifying the route the driver app intends to take to the next waypoint. Your driver app updates this every time a waypoint is passed or the driver reroutes. This list is also returned in Trip.current_route_segment for all active trips assigned to the vehicle. Note: This field is intended only for use by the Driver SDK.

current_route_segment_version: Option<Timestamp>

Time when current_route_segment was set. This field is ignored in UpdateVehicleRequests as it is calculated by the server. It should be stored by client and passed in to future requests to prevent returning routes to first way point that haven’t changed.

current_route_segment_end_point: Option<TripWaypoint>

The waypoint where current_route_segment ends. This can be supplied by drivers on UpdateVehicle calls either as a full trip waypoint, a waypoint latlnt, or as a the last latlng of the current_route_segment. FleetEngine will then do its best to interpolate to an actual waypoint if it is not fully specified. This field is ignored in UpdateVehicle calls unless current_route_segment is also specified.

remaining_distance_meters: Option<i32>

The remaining driving distance for the ‘current_route_segment’. This field facilitates journey sharing between the Driver app and the Consumer app. This value is updated by the Driver SDK. Fleet Engine does not update it. This field is also returned in Trip.remaining_distance_meters for all active trips assigned to the vehicle. The value is unspecified if the Vehicle.current_route_segment field is empty, or if the Driver app has not updated its value.

eta_to_first_waypoint: Option<Timestamp>

The ETA to the next waypoint that is the first entry in Vehicle.waypoint field. This field facilitates journey sharing between a Driver app and a Consumer app and is updated by the Driver SDK, and Fleet Engine does not update it. This field is also returned in Trip.eta_to_first_waypoint for all active trips assigned to the vehicle. The value is unspecified if the Vehicle.waypoint field is empty, or the Driver app has not updated its value.

remaining_time_seconds: Option<i32>

The remaining driving time for the ‘current_route_segment’. This field facilitates journey sharing between the Driver app and the Consumer app. This value is updated by the Driver SDK. Fleet Engine does not update it. The value is unspecified if the Vehicle.current_route_segment field is empty, or if the Driver app has not updated its value. This value should match eta_to_first_waypoint - current_time if all parties are using the same clock. This field is currently write-only and will not yet be populated in Vehicle’s get/update/search operations. When updating a vehicle, if you update both eta_to_first_waypoint and remaining_time_seconds in the same request, then only remaining_time_seconds is considered.

waypoints: Vec<TripWaypoint>

The remaining set of waypoints assigned to this Vehicle.

waypoints_version: Option<Timestamp>

Last time the waypoints was updated. Client should cache this value and pass it in GetVehicleRequest to ensure the waypoints.path_to_waypoint is only returned if it is updated

back_to_back_enabled: bool

Indicates if the driver accepts back-to-back rides. If true, services include the vehicle for back-to-back matches. If false, services exclude the vehicle from back-to-back matches. Default value is false.

navigation_status: i32

Vehicle’s navigation status.

device_settings: Option<DeviceSettings>

Information about various device settings. This is internal debug only field, not included in the response.

Implementations

impl Vehicle

pub fn vehicle_state(&self) -> VehicleState

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

pub fn set_vehicle_state(&mut self, value: VehicleState)

Sets vehicle_state to the provided enum value.

pub fn supported_trip_types(
    &self
) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<TripType>>

Returns an iterator which yields the valid enum values contained in supported_trip_types.

pub fn push_supported_trip_types(&mut self, value: TripType)

Appends the provided enum value to supported_trip_types.

pub fn navigation_status(&self) -> NavigationStatus

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: NavigationStatus)

Sets navigation_status to the provided enum value.

Trait Implementations

impl Clone for Vehicle

fn clone(&self) -> Vehicle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vehicle

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

Formats the value using the given formatter.

impl Default for Vehicle

fn default() -> Self

Returns the “default value” for a type.

impl Message for Vehicle

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

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

Encodes the message to a newly allocated buffer.

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

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

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

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

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<Vehicle> for Vehicle

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

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

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

This method tests for !=.

impl StructuralPartialEq for Vehicle