Class protos.google.maps.routing.v2.ComputeRouteMatrixRequest (2.2.0)

Represents a ComputeRouteMatrixRequest.

Package

@googlemaps/routing

Constructors

(constructor)(properties)

constructor(properties?: google.maps.routing.v2.IComputeRouteMatrixRequest);

Constructs a new ComputeRouteMatrixRequest.

Parameter
Name Description
properties IComputeRouteMatrixRequest

Properties to set

Properties

arrivalTime

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

ComputeRouteMatrixRequest arrivalTime.

departureTime

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

ComputeRouteMatrixRequest departureTime.

destinations

public destinations: google.maps.routing.v2.IRouteMatrixDestination[];

ComputeRouteMatrixRequest destinations.

extraComputations

public extraComputations: google.maps.routing.v2.ComputeRouteMatrixRequest.ExtraComputation[];

ComputeRouteMatrixRequest extraComputations.

languageCode

public languageCode: string;

ComputeRouteMatrixRequest languageCode.

origins

public origins: google.maps.routing.v2.IRouteMatrixOrigin[];

ComputeRouteMatrixRequest origins.

regionCode

public regionCode: string;

ComputeRouteMatrixRequest regionCode.

routingPreference

public routingPreference: (google.maps.routing.v2.RoutingPreference|keyof typeof google.maps.routing.v2.RoutingPreference);

ComputeRouteMatrixRequest routingPreference.

trafficModel

public trafficModel: (google.maps.routing.v2.TrafficModel|keyof typeof google.maps.routing.v2.TrafficModel);

ComputeRouteMatrixRequest trafficModel.

transitPreferences

public transitPreferences?: (google.maps.routing.v2.ITransitPreferences|null);

ComputeRouteMatrixRequest transitPreferences.

travelMode

public travelMode: (google.maps.routing.v2.RouteTravelMode|keyof typeof google.maps.routing.v2.RouteTravelMode);

ComputeRouteMatrixRequest travelMode.

units

public units: (google.maps.routing.v2.Units|keyof typeof google.maps.routing.v2.Units);

ComputeRouteMatrixRequest units.

Methods

create(properties)

public static create(properties?: google.maps.routing.v2.IComputeRouteMatrixRequest): google.maps.routing.v2.ComputeRouteMatrixRequest;

Creates a new ComputeRouteMatrixRequest instance using the specified properties.

Parameter
Name Description
properties IComputeRouteMatrixRequest

Properties to set

Returns
Type Description
ComputeRouteMatrixRequest

ComputeRouteMatrixRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.routing.v2.ComputeRouteMatrixRequest;

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

ComputeRouteMatrixRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.routing.v2.ComputeRouteMatrixRequest;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ComputeRouteMatrixRequest

ComputeRouteMatrixRequest

encode(message, writer)

public static encode(message: google.maps.routing.v2.IComputeRouteMatrixRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ComputeRouteMatrixRequest message. Does not implicitly messages.

Parameters
Name Description
message IComputeRouteMatrixRequest

ComputeRouteMatrixRequest 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: google.maps.routing.v2.IComputeRouteMatrixRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IComputeRouteMatrixRequest

ComputeRouteMatrixRequest 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 }): google.maps.routing.v2.ComputeRouteMatrixRequest;

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

ComputeRouteMatrixRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ComputeRouteMatrixRequest

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

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

JSON object

toObject(message, options)

public static toObject(message: google.maps.routing.v2.ComputeRouteMatrixRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message ComputeRouteMatrixRequest

ComputeRouteMatrixRequest

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 ComputeRouteMatrixRequest 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