Class protos.google.maps.routing.v2.ComputeRoutesRequest (0.3.1)

Version latest

• 0.3.1 (latest)
• 0.3.0
• 0.2.1

Represents a ComputeRoutesRequest.

Package

@googlemaps/routing

Constructors

(constructor)(properties)

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

Constructs a new ComputeRoutesRequest.

Parameter
Name	Description
properties	IComputeRoutesRequest Properties to set

Properties

computeAlternativeRoutes

public computeAlternativeRoutes: boolean;

ComputeRoutesRequest computeAlternativeRoutes.

departureTime

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

ComputeRoutesRequest departureTime.

destination

public destination?: (google.maps.routing.v2.IWaypoint|null);

ComputeRoutesRequest destination.

extraComputations

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

ComputeRoutesRequest extraComputations.

intermediates

public intermediates: google.maps.routing.v2.IWaypoint[];

ComputeRoutesRequest intermediates.

languageCode

public languageCode: string;

ComputeRoutesRequest languageCode.

origin

public origin?: (google.maps.routing.v2.IWaypoint|null);

ComputeRoutesRequest origin.

polylineEncoding

public polylineEncoding: (google.maps.routing.v2.PolylineEncoding|keyof typeof google.maps.routing.v2.PolylineEncoding);

ComputeRoutesRequest polylineEncoding.

polylineQuality

public polylineQuality: (google.maps.routing.v2.PolylineQuality|keyof typeof google.maps.routing.v2.PolylineQuality);

ComputeRoutesRequest polylineQuality.

requestedReferenceRoutes

public requestedReferenceRoutes: google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute[];

ComputeRoutesRequest requestedReferenceRoutes.

routeModifiers

public routeModifiers?: (google.maps.routing.v2.IRouteModifiers|null);

ComputeRoutesRequest routeModifiers.

routingPreference

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

ComputeRoutesRequest routingPreference.

travelMode

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

ComputeRoutesRequest travelMode.

units

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

ComputeRoutesRequest units.

Methods

create(properties)

public static create(properties?: google.maps.routing.v2.IComputeRoutesRequest): google.maps.routing.v2.ComputeRoutesRequest;

Creates a new ComputeRoutesRequest instance using the specified properties.

Parameter
Name	Description
properties	IComputeRoutesRequest Properties to set

Returns
Type	Description
google.maps.routing.v2.ComputeRoutesRequest	ComputeRoutesRequest instance

decode(reader, length)

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

Decodes a ComputeRoutesRequest message from the specified reader or buffer.

Parameters
Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from
length	number Message length if known beforehand

Returns
Type	Description
google.maps.routing.v2.ComputeRoutesRequest	ComputeRoutesRequest

decodeDelimited(reader)

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

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

Parameter
Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from

Returns
Type	Description
google.maps.routing.v2.ComputeRoutesRequest	ComputeRoutesRequest

encode(message, writer)

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

Encodes the specified ComputeRoutesRequest message. Does not implicitly messages.

Parameters
Name	Description
message	IComputeRoutesRequest ComputeRoutesRequest 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.IComputeRoutesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
message	IComputeRoutesRequest ComputeRoutesRequest 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.ComputeRoutesRequest;

Creates a ComputeRoutesRequest 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
google.maps.routing.v2.ComputeRoutesRequest	ComputeRoutesRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ComputeRoutesRequest

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

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

toObject(message, options)

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

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

Parameters
Name	Description
message	google.maps.routing.v2.ComputeRoutesRequest ComputeRoutesRequest
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 ComputeRoutesRequest 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