xref: /aosp_15_r20/external/googleapis/google/maps/routing/v2/traffic_model.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 = "TrafficModelProto";
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// Specifies the assumptions to use when calculating time in traffic. This
30// setting affects the value returned in the `duration` field in the
31// response, which contains the predicted time in traffic based on historical
32// averages.
33enum TrafficModel {
34  // Unused. If specified, will default to `BEST_GUESS`.
35  TRAFFIC_MODEL_UNSPECIFIED = 0;
36
37  // Indicates that the returned `duration` should be the best
38  // estimate of travel time given what is known about both historical traffic
39  // conditions and live traffic. Live traffic becomes more important the closer
40  // the `departure_time` is to now.
41  BEST_GUESS = 1;
42
43  // Indicates that the returned duration should be longer than the
44  // actual travel time on most days, though occasional days with particularly
45  // bad traffic conditions may exceed this value.
46  PESSIMISTIC = 2;
47
48  // Indicates that the returned duration should be shorter than the actual
49  // travel time on most days, though occasional days with particularly good
50  // traffic conditions may be faster than this value.
51  OPTIMISTIC = 3;
52}
53