google.maps.routing.v2.traffic_model.proto Maven / Gradle / Ivy

Go to download
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

package google.maps.routing.v2;

option cc_enable_arenas = true;
option csharp_namespace = "Google.Maps.Routing.V2";
option go_package = "cloud.google.com/go/maps/routing/apiv2/routingpb;routingpb";
option java_multiple_files = true;
option java_outer_classname = "TrafficModelProto";
option java_package = "com.google.maps.routing.v2";
option objc_class_prefix = "GMRV2";
option php_namespace = "Google\\Maps\\Routing\\V2";
option ruby_package = "Google::Maps::Routing::V2";

// Specifies the assumptions to use when calculating time in traffic. This
// setting affects the value returned in the `duration` field in the
// response, which contains the predicted time in traffic based on historical
// averages.
enum TrafficModel {
  // Unused. If specified, will default to `BEST_GUESS`.
  TRAFFIC_MODEL_UNSPECIFIED = 0;

  // Indicates that the returned `duration` should be the best
  // estimate of travel time given what is known about both historical traffic
  // conditions and live traffic. Live traffic becomes more important the closer
  // the `departure_time` is to now.
  BEST_GUESS = 1;

  // Indicates that the returned duration should be longer than the
  // actual travel time on most days, though occasional days with particularly
  // bad traffic conditions may exceed this value.
  PESSIMISTIC = 2;

  // Indicates that the returned duration should be shorter than the actual
  // travel time on most days, though occasional days with particularly good
  // traffic conditions may be faster than this value.
  OPTIMISTIC = 3;
}