Class ComputeRouteMatrixRequest

ComputeRouteMatrix request message

Inheritance
object
ComputeRouteMatrixRequest
Implements
Inherited Members
Namespace: Google.Maps.Routing.V2
Assembly: Google.Maps.Routing.V2.dll
Syntax
public sealed class ComputeRouteMatrixRequest : IMessage<ComputeRouteMatrixRequest>, IEquatable<ComputeRouteMatrixRequest>, IDeepCloneable<ComputeRouteMatrixRequest>, IBufferMessage, IMessage

Constructors

ComputeRouteMatrixRequest()

Declaration
public ComputeRouteMatrixRequest()

ComputeRouteMatrixRequest(ComputeRouteMatrixRequest)

Declaration
public ComputeRouteMatrixRequest(ComputeRouteMatrixRequest other)
Parameters
Type Name Description
ComputeRouteMatrixRequest other

Properties

ArrivalTime

Optional. The arrival time. NOTE: Can only be set when [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to TRANSIT. You can specify either departure_time or arrival_time, but not both.

Declaration
public Timestamp ArrivalTime { get; set; }
Property Value
Type Description
Timestamp

DepartureTime

Optional. The departure time. If you don't set this value, then this value defaults to the time that you made the request. NOTE: You can only specify a departure_time in the past when [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to TRANSIT.

Declaration
public Timestamp DepartureTime { get; set; }
Property Value
Type Description
Timestamp

Destinations

Required. Array of destinations, which determines the columns of the response matrix.

Declaration
public RepeatedField<RouteMatrixDestination> Destinations { get; }
Property Value
Type Description
RepeatedField<RouteMatrixDestination>

ExtraComputations

Optional. A list of extra computations which may be used to complete the request. Note: These extra computations may return extra fields on the response. These extra fields must also be specified in the field mask to be returned in the response.

Declaration
public RepeatedField<ComputeRouteMatrixRequest.Types.ExtraComputation> ExtraComputations { get; }
Property Value
Type Description
RepeatedField<ComputeRouteMatrixRequest.Types.ExtraComputation>

LanguageCode

Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Unicode Locale Identifier. See Language Support for the list of supported languages. When you don't provide this value, the display language is inferred from the location of the first origin.

Declaration
public string LanguageCode { get; set; }
Property Value
Type Description
string

Origins

Required. Array of origins, which determines the rows of the response matrix. Several size restrictions apply to the cardinality of origins and destinations:

  • The sum of the number of origins + the number of destinations specified as either place_id or address must be no greater than 50.
  • The product of number of origins × number of destinations must be no greater than 625 in any case.
  • The product of the number of origins × number of destinations must be no greater than 100 if routing_preference is set to TRAFFIC_AWARE_OPTIMAL.
  • The product of the number of origins × number of destinations must be no greater than 100 if travel_mode is set to TRANSIT.
Declaration
public RepeatedField<RouteMatrixOrigin> Origins { get; }
Property Value
Type Description
RepeatedField<RouteMatrixOrigin>

RegionCode

Optional. The region code, specified as a ccTLD ("top-level domain") two-character value. For more information see Country code top-level domains.

Declaration
public string RegionCode { get; set; }
Property Value
Type Description
string

RoutingPreference

Optional. Specifies how to compute the route. The server attempts to use the selected routing preference to compute the route. If the routing preference results in an error or an extra long latency, an error is returned. You can specify this option only when the travel_mode is DRIVE or TWO_WHEELER, otherwise the request fails.

Declaration
public RoutingPreference RoutingPreference { get; set; }
Property Value
Type Description
RoutingPreference

TrafficModel

Optional. Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration field in the [RouteMatrixElement][google.maps.routing.v2.RouteMatrixElement] which contains the predicted time in traffic based on historical averages. [RoutingPreference][google.maps.routing.v2.RoutingPreference] to TRAFFIC_AWARE_OPTIMAL and [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] to DRIVE. Defaults to BEST_GUESS if traffic is requested and TrafficModel is not specified.

Declaration
public TrafficModel TrafficModel { get; set; }
Property Value
Type Description
TrafficModel

TransitPreferences

Optional. Specifies preferences that influence the route returned for TRANSIT routes. NOTE: You can only specify a transit_preferences when [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to TRANSIT.

Declaration
public TransitPreferences TransitPreferences { get; set; }
Property Value
Type Description
TransitPreferences

TravelMode

Optional. Specifies the mode of transportation.

Declaration
public RouteTravelMode TravelMode { get; set; }
Property Value
Type Description
RouteTravelMode

Units

Optional. Specifies the units of measure for the display fields.

Declaration
public Units Units { get; set; }
Property Value
Type Description
Units