xref: /aosp_15_r20/external/googleapis/google/maps/routing/v2/route_label.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 = "RouteLabelProto";
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// Labels for the [`Route`][google.maps.routing.v2.Route] that are useful to
30// identify specific properties of the route to compare against others.
31enum RouteLabel {
32  // Default - not used.
33  ROUTE_LABEL_UNSPECIFIED = 0;
34
35  // The default "best" route returned for the route computation.
36  DEFAULT_ROUTE = 1;
37
38  // An alternative to the default "best" route. Routes like this will be
39  // returned when
40  // [`compute_alternative_routes`][google.maps.routing.v2.ComputeRoutesRequest.compute_alternative_routes]
41  // is specified.
42  DEFAULT_ROUTE_ALTERNATE = 2;
43
44  // Fuel efficient route. Routes labeled with this value are determined to be
45  // optimized for Eco parameters such as fuel consumption.
46  FUEL_EFFICIENT = 3;
47}
48