xref: /aosp_15_r20/external/googleapis/google/maps/routes/v1/custom_route.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2022 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.routes.v1;
18
19import "google/maps/routes/v1/route.proto";
20
21option cc_enable_arenas = true;
22option csharp_namespace = "Google.Maps.Routes.V1";
23option go_package = "cloud.google.com/go/maps/routes/apiv1/routespb;routespb";
24option java_multiple_files = true;
25option java_outer_classname = "CustomRouteProto";
26option java_package = "com.google.maps.routes.v1";
27option objc_class_prefix = "GMRS";
28option php_namespace = "Google\\Maps\\Routes\\V1";
29
30// Encapsulates a custom route computed based on the route objective specified
31// by the customer. CustomRoute contains a route and a route token, which can be
32// passed to NavSDK to reconstruct the custom route for turn by turn navigation.
33message CustomRoute {
34  // The route considered 'best' for the input route objective.
35  Route route = 11;
36
37  // Web-safe base64 encoded route token that can be passed to NavSDK, which
38  // allows NavSDK to reconstruct the route during navigation, and in the event
39  // of rerouting honor the original intention when RoutesPreferred
40  // ComputeCustomRoutes is called. Customers should treat this token as an
41  // opaque blob.
42  string token = 12;
43}
44