Class protos.maps.fleetengine.v1.VehicleMatch (0.5.0)

Represents a VehicleMatch.

Package

@googlemaps/fleetengine

Constructors

(constructor)(properties)

constructor(properties?: maps.fleetengine.v1.IVehicleMatch);

Constructs a new VehicleMatch.

Parameter
Name Description
properties IVehicleMatch

Properties to set

Properties

orderedBy

public orderedBy: (maps.fleetengine.v1.SearchVehiclesRequest.VehicleMatchOrder|keyof typeof maps.fleetengine.v1.SearchVehiclesRequest.VehicleMatchOrder);

VehicleMatch orderedBy.

requestedOrderedBy

public requestedOrderedBy: (maps.fleetengine.v1.SearchVehiclesRequest.VehicleMatchOrder|keyof typeof maps.fleetengine.v1.SearchVehiclesRequest.VehicleMatchOrder);

VehicleMatch requestedOrderedBy.

tripType

public tripType: (maps.fleetengine.v1.TripType|keyof typeof maps.fleetengine.v1.TripType);

VehicleMatch tripType.

vehicle

public vehicle?: (maps.fleetengine.v1.IVehicle|null);

VehicleMatch vehicle.

vehicleDropoffEta

public vehicleDropoffEta?: (google.protobuf.ITimestamp|null);

VehicleMatch vehicleDropoffEta.

vehicleMatchType

public vehicleMatchType: (maps.fleetengine.v1.VehicleMatch.VehicleMatchType|keyof typeof maps.fleetengine.v1.VehicleMatch.VehicleMatchType);

VehicleMatch vehicleMatchType.

vehiclePickupDistanceMeters

public vehiclePickupDistanceMeters?: (google.protobuf.IInt32Value|null);

VehicleMatch vehiclePickupDistanceMeters.

vehiclePickupEta

public vehiclePickupEta?: (google.protobuf.ITimestamp|null);

VehicleMatch vehiclePickupEta.

vehiclePickupStraightLineDistanceMeters

public vehiclePickupStraightLineDistanceMeters?: (google.protobuf.IInt32Value|null);

VehicleMatch vehiclePickupStraightLineDistanceMeters.

vehiclePickupToDropoffDistanceMeters

public vehiclePickupToDropoffDistanceMeters?: (google.protobuf.IInt32Value|null);

VehicleMatch vehiclePickupToDropoffDistanceMeters.

vehicleTripsWaypoints

public vehicleTripsWaypoints: maps.fleetengine.v1.IWaypoint[];

VehicleMatch vehicleTripsWaypoints.

Methods

create(properties)

public static create(properties?: maps.fleetengine.v1.IVehicleMatch): maps.fleetengine.v1.VehicleMatch;

Creates a new VehicleMatch instance using the specified properties.

Parameter
Name Description
properties IVehicleMatch

Properties to set

Returns
Type Description
VehicleMatch

VehicleMatch instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): maps.fleetengine.v1.VehicleMatch;

Decodes a VehicleMatch 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
VehicleMatch

VehicleMatch

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): maps.fleetengine.v1.VehicleMatch;

Decodes a VehicleMatch message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
VehicleMatch

VehicleMatch

encode(message, writer)

public static encode(message: maps.fleetengine.v1.IVehicleMatch, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified VehicleMatch message. Does not implicitly messages.

Parameters
Name Description
message IVehicleMatch

VehicleMatch 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.IVehicleMatch, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified VehicleMatch message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IVehicleMatch

VehicleMatch 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.VehicleMatch;

Creates a VehicleMatch 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
VehicleMatch

VehicleMatch

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for VehicleMatch

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 VehicleMatch to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: maps.fleetengine.v1.VehicleMatch, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a VehicleMatch message. Also converts values to other types if specified.

Parameters
Name Description
message VehicleMatch

VehicleMatch

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 VehicleMatch message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not