Represents a Vehicle.
Package
@googlemaps/fleetengineConstructors
(constructor)(properties)
constructor(properties?: maps.fleetengine.v1.IVehicle);Constructs a new Vehicle.
| Parameter | |
|---|---|
| Name | Description |
properties |
IVehicle
Properties to set |
Properties
attributes
public attributes: maps.fleetengine.v1.IVehicleAttribute[];Vehicle attributes.
backToBackEnabled
public backToBackEnabled: boolean;Vehicle backToBackEnabled.
currentRouteSegment
public currentRouteSegment: string;Vehicle currentRouteSegment.
currentRouteSegmentEndPoint
public currentRouteSegmentEndPoint?: (maps.fleetengine.v1.ITripWaypoint|null);Vehicle currentRouteSegmentEndPoint.
currentRouteSegmentTraffic
public currentRouteSegmentTraffic?: (maps.fleetengine.v1.ITrafficPolylineData|null);Vehicle currentRouteSegmentTraffic.
currentRouteSegmentVersion
public currentRouteSegmentVersion?: (google.protobuf.ITimestamp|null);Vehicle currentRouteSegmentVersion.
currentTrips
public currentTrips: string[];Vehicle currentTrips.
deviceSettings
public deviceSettings?: (maps.fleetengine.v1.IDeviceSettings|null);Vehicle deviceSettings.
etaToFirstWaypoint
public etaToFirstWaypoint?: (google.protobuf.ITimestamp|null);Vehicle etaToFirstWaypoint.
lastLocation
public lastLocation?: (maps.fleetengine.v1.IVehicleLocation|null);Vehicle lastLocation.
licensePlate
public licensePlate?: (maps.fleetengine.v1.ILicensePlate|null);Vehicle licensePlate.
maximumCapacity
public maximumCapacity: number;Vehicle maximumCapacity.
name
public name: string;Vehicle name.
navigationStatus
public navigationStatus: (maps.fleetengine.v1.NavigationStatus|keyof typeof maps.fleetengine.v1.NavigationStatus);Vehicle navigationStatus.
pastLocations
public pastLocations: maps.fleetengine.v1.IVehicleLocation[];Vehicle pastLocations.
remainingDistanceMeters
public remainingDistanceMeters?: (google.protobuf.IInt32Value|null);Vehicle remainingDistanceMeters.
remainingTimeSeconds
public remainingTimeSeconds?: (google.protobuf.IInt32Value|null);Vehicle remainingTimeSeconds.
route
public route: maps.fleetengine.v1.ITerminalLocation[];Vehicle route.
supportedTripTypes
public supportedTripTypes: maps.fleetengine.v1.TripType[];Vehicle supportedTripTypes.
vehicleState
public vehicleState: (maps.fleetengine.v1.VehicleState|keyof typeof maps.fleetengine.v1.VehicleState);Vehicle vehicleState.
vehicleType
public vehicleType?: (maps.fleetengine.v1.Vehicle.IVehicleType|null);Vehicle vehicleType.
waypoints
public waypoints: maps.fleetengine.v1.ITripWaypoint[];Vehicle waypoints.
waypointsVersion
public waypointsVersion?: (google.protobuf.ITimestamp|null);Vehicle waypointsVersion.
Methods
create(properties)
public static create(properties?: maps.fleetengine.v1.IVehicle): maps.fleetengine.v1.Vehicle;Creates a new Vehicle instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IVehicle
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Vehicle |
Vehicle instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): maps.fleetengine.v1.Vehicle;Decodes a Vehicle message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Vehicle |
Vehicle |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): maps.fleetengine.v1.Vehicle;Decodes a Vehicle message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Vehicle |
Vehicle |
encode(message, writer)
public static encode(message: maps.fleetengine.v1.IVehicle, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Vehicle message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IVehicle
Vehicle message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: maps.fleetengine.v1.IVehicle, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Vehicle message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IVehicle
Vehicle message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): maps.fleetengine.v1.Vehicle;Creates a Vehicle message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Vehicle |
Vehicle |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Vehicle
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Vehicle to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: maps.fleetengine.v1.Vehicle, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Vehicle message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Vehicle
Vehicle |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Vehicle message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|