Class Vehicle
Vehicle metadata.
Namespace: Google.Maps.FleetEngine.V1
Assembly: Google.Maps.FleetEngine.V1.dll
Syntax
public sealed class Vehicle : IMessage<Vehicle>, IEquatable<Vehicle>, IDeepCloneable<Vehicle>, IBufferMessage, IMessage
Constructors
Vehicle()
Declaration
public Vehicle()
Vehicle(Vehicle)
Declaration
public Vehicle(Vehicle other)
Parameters
| Type | Name | Description |
|---|---|---|
| Vehicle | other |
Properties
Attributes
List of vehicle attributes. A vehicle can have at most 100 attributes, and each attribute must have a unique key.
Declaration
public RepeatedField<VehicleAttribute> Attributes { get; }
Property Value
| Type | Description |
|---|---|
| RepeatedField<VehicleAttribute> |
BackToBackEnabled
Indicates if the driver accepts back-to-back trips. If true,
SearchVehicles may include the vehicle even if it is currently assigned
to a trip. The default value is false.
Declaration
public bool BackToBackEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
CurrentRouteSegment
The polyline specifying the route the driver app intends to take to
the next waypoint. 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. Decoding is not yet supported.
Declaration
public string CurrentRouteSegment { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
CurrentRouteSegmentEndPoint
The waypoint where current_route_segment ends. This can be supplied by
drivers on UpdateVehicle calls either as a full trip waypoint, a waypoint
LatLng, or as the last LatLng of the current_route_segment. Fleet
Engine 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.
Declaration
public TripWaypoint CurrentRouteSegmentEndPoint { get; set; }
Property Value
| Type | Description |
|---|---|
| TripWaypoint |
CurrentRouteSegmentTraffic
Input only. Fleet Engine uses this information to improve journey sharing. Note: This field is intended only for use by the Driver SDK.
Declaration
public TrafficPolylineData CurrentRouteSegmentTraffic { get; set; }
Property Value
| Type | Description |
|---|---|
| TrafficPolylineData |
CurrentRouteSegmentVersion
Output only. Time when current_route_segment was set. It can be stored by
the client and passed in future GetVehicle requests to prevent returning
routes that haven't changed.
Declaration
public Timestamp CurrentRouteSegmentVersion { get; set; }
Property Value
| Type | Description |
|---|---|
| Timestamp |
CurrentTrips
Output only. List of trip_id's for trips currently assigned to this
vehicle.
Declaration
public RepeatedField<string> CurrentTrips { get; }
Property Value
| Type | Description |
|---|---|
| RepeatedField<string> |
DeviceSettings
Input only. Information about settings in the mobile device being used by the driver.
Declaration
public DeviceSettings DeviceSettings { get; set; }
Property Value
| Type | Description |
|---|---|
| DeviceSettings |
EtaToFirstWaypoint
The ETA to the first entry in the waypoints field. The value is
unspecified if the waypoints field is empty or the
Vehicle.current_route_segment field is empty.
When updating a vehicle, remaining_time_seconds takes precedence over
eta_to_first_waypoint in the same request.
Declaration
public Timestamp EtaToFirstWaypoint { get; set; }
Property Value
| Type | Description |
|---|---|
| Timestamp |
LastLocation
Last reported location of the vehicle.
Declaration
public VehicleLocation LastLocation { get; set; }
Property Value
| Type | Description |
|---|---|
| VehicleLocation |
LicensePlate
License plate information for the vehicle.
Declaration
public LicensePlate LicensePlate { get; set; }
Property Value
| Type | Description |
|---|---|
| LicensePlate |
MaximumCapacity
The total numbers of riders this vehicle can carry. The driver is not considered in this value. This value must be greater than or equal to one.
Declaration
public int MaximumCapacity { get; set; }
Property Value
| Type | Description |
|---|---|
| int |
Name
Output only. The unique name for this vehicle.
The format is providers/{provider}/vehicles/{vehicle}.
Declaration
public string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
NavigationStatus
The vehicle's navigation status.
Declaration
public NavigationStatus NavigationStatus { get; set; }
Property Value
| Type | Description |
|---|---|
| NavigationStatus |
PastLocations
Input only. Locations where this vehicle has been in the past that haven't
yet been reported to Fleet Engine. This is used in UpdateVehicleRequest
to record locations which were previously unable to be sent to the server.
Typically this happens when the vehicle does not have internet
connectivity.
Declaration
public RepeatedField<VehicleLocation> PastLocations { get; }
Property Value
| Type | Description |
|---|---|
| RepeatedField<VehicleLocation> |
RemainingDistanceMeters
The remaining driving distance for the current_route_segment.
This value is also returned in Trip.remaining_distance_meters for all
active trips assigned to the vehicle. The value is unspecified if the
current_route_segment field is empty.
Declaration
public int? RemainingDistanceMeters { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
RemainingTimeSeconds
Input only. The remaining driving time for the current_route_segment. The
value is unspecified if the waypoints field is empty or the
Vehicle.current_route_segment field is empty. This value should match
eta_to_first_waypoint - current_time if all parties are using the same
clock.
When updating a vehicle, remaining_time_seconds takes precedence over
eta_to_first_waypoint in the same request.
Declaration
public int? RemainingTimeSeconds { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
Route
Deprecated: Use Vehicle.waypoints instead.
Declaration
[Obsolete]
public RepeatedField<TerminalLocation> Route { get; }
Property Value
| Type | Description |
|---|---|
| RepeatedField<TerminalLocation> |
SupportedTripTypes
Trip types supported by this vehicle.
Declaration
public RepeatedField<TripType> SupportedTripTypes { get; }
Property Value
| Type | Description |
|---|---|
| RepeatedField<TripType> |
VehicleName
VehicleName-typed view over the Name resource name property.
Declaration
public VehicleName VehicleName { get; set; }
Property Value
| Type | Description |
|---|---|
| VehicleName |
VehicleState
The vehicle state.
Declaration
public VehicleState VehicleState { get; set; }
Property Value
| Type | Description |
|---|---|
| VehicleState |
VehicleType
Required. The type of this vehicle. Can be used to filter vehicles in
SearchVehicles results. Also influences ETA and route calculations.
Declaration
public Vehicle.Types.VehicleType VehicleType { get; set; }
Property Value
| Type | Description |
|---|---|
| Vehicle.Types.VehicleType |
Waypoints
The remaining waypoints assigned to this Vehicle.
Declaration
public RepeatedField<TripWaypoint> Waypoints { get; }
Property Value
| Type | Description |
|---|---|
| RepeatedField<TripWaypoint> |
WaypointsVersion
Output only. Last time the waypoints field was updated. Clients should
cache this value and pass it in GetVehicleRequest to ensure the
waypoints field is only returned if it is updated.
Declaration
public Timestamp WaypointsVersion { get; set; }
Property Value
| Type | Description |
|---|---|
| Timestamp |