xref: /aosp_15_r20/external/googleapis/google/maps/routing/v2/routing_preference.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.maps.routing.v2;
18
19option cc_enable_arenas = true;
20option csharp_namespace = "Google.Maps.Routing.V2";
21option go_package = "cloud.google.com/go/maps/routing/apiv2/routingpb;routingpb";
22option java_multiple_files = true;
23option java_outer_classname = "RoutingPreferenceProto";
24option java_package = "com.google.maps.routing.v2";
25option objc_class_prefix = "GMRV2";
26option php_namespace = "Google\\Maps\\Routing\\V2";
27option ruby_package = "Google::Maps::Routing::V2";
28
29// A set of values that specify factors to take into consideration when
30// calculating the route.
31enum RoutingPreference {
32  // No routing preference specified. Default to `TRAFFIC_UNAWARE`.
33  ROUTING_PREFERENCE_UNSPECIFIED = 0;
34
35  // Computes routes without taking live traffic conditions into consideration.
36  // Suitable when traffic conditions don't matter or are not applicable.
37  // Using this value produces the lowest latency.
38  // Note: For [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode]
39  // `DRIVE` and `TWO_WHEELER`, the route and duration chosen are based on road
40  // network and average time-independent traffic conditions, not current road
41  // conditions. Consequently, routes may include roads that are temporarily
42  // closed. Results for a given
43  // request may vary over time due to changes in the road network, updated
44  // average traffic conditions, and the distributed nature of the service.
45  // Results may also vary between nearly-equivalent routes at any time or
46  // frequency.
47  TRAFFIC_UNAWARE = 1;
48
49  // Calculates routes taking live traffic conditions into consideration.
50  // In contrast to `TRAFFIC_AWARE_OPTIMAL`, some optimizations are applied to
51  // significantly reduce latency.
52  TRAFFIC_AWARE = 2;
53
54  // Calculates the routes taking live traffic conditions into consideration,
55  // without applying most performance optimizations. Using this value produces
56  // the highest latency.
57  TRAFFIC_AWARE_OPTIMAL = 3;
58}
59