google.maps.routing.v2.routing_preference.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 = "RoutingPreferenceProto";
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";

// A set of values that specify factors to take into consideration when
// calculating the route.
enum RoutingPreference {
  // No routing preference specified. Default to `TRAFFIC_UNAWARE`.
  ROUTING_PREFERENCE_UNSPECIFIED = 0;

  // Computes routes without taking live traffic conditions into consideration.
  // Suitable when traffic conditions don't matter or are not applicable.
  // Using this value produces the lowest latency.
  // Note: For [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode]
  // `DRIVE` and `TWO_WHEELER`, the route and duration chosen are based on road
  // network and average time-independent traffic conditions, not current road
  // conditions. Consequently, routes may include roads that are temporarily
  // closed. Results for a given
  // request may vary over time due to changes in the road network, updated
  // average traffic conditions, and the distributed nature of the service.
  // Results may also vary between nearly-equivalent routes at any time or
  // frequency.
  TRAFFIC_UNAWARE = 1;

  // Calculates routes taking live traffic conditions into consideration.
  // In contrast to `TRAFFIC_AWARE_OPTIMAL`, some optimizations are applied to
  // significantly reduce latency.
  TRAFFIC_AWARE = 2;

  // Calculates the routes taking live traffic conditions into consideration,
  // without applying most performance optimizations. Using this value produces
  // the highest latency.
  TRAFFIC_AWARE_OPTIMAL = 3;
}