xref: /aosp_15_r20/external/googleapis/google/maps/routes/v1/compute_routes_response.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/fallback_info.proto";
20import "google/maps/routes/v1/route.proto";
21
22option cc_enable_arenas = true;
23option csharp_namespace = "Google.Maps.Routes.V1";
24option go_package = "cloud.google.com/go/maps/routes/apiv1/routespb;routespb";
25option java_multiple_files = true;
26option java_outer_classname = "ComputeRoutesResponseProto";
27option java_package = "com.google.maps.routes.v1";
28option objc_class_prefix = "GMRS";
29option php_namespace = "Google\\Maps\\Routes\\V1";
30
31// ComputeRoutes the response message.
32message ComputeRoutesResponse {
33  // Contains an array of computed routes (up to three) when you specify
34  // compute_alternatives_routes, and contains just one route when you don't.
35  // When this array contains multiple entries, the first one is the most
36  // recommended route. If the array is empty, then it means no route could be
37  // found.
38  repeated Route routes = 1;
39
40  // In some cases when the server is not able to compute the route results with
41  // all of the input preferences, it may fallback to using a different way of
42  // computation. When fallback mode is used, this field contains detailed info
43  // about the fallback response. Otherwise this field is unset.
44  FallbackInfo fallback_info = 2;
45}
46