feat: added the route modifiers

Google APIs · copybara-github · commit d1ed9b8459d0 · 2023-10-12T09:52:16.000-07:00
Users can now set optional conditions when calculating vehicle routes.

PiperOrigin-RevId: 572934958
diff --git a/google/cloud/optimization/v1/BUILD.bazel b/google/cloud/optimization/v1/BUILD.bazel
@@ -220,7 +220,9 @@ php_gapic_library(
     rest_numeric_enums = True,
     service_yaml = "cloudoptimization_v1.yaml",
     transport = "grpc+rest",
-    deps = [":optimization_php_proto"],
+    deps = [
+        ":optimization_php_proto",
+    ],
 )
 
 # Open Source Packages
@@ -328,6 +330,7 @@ load(
 
 csharp_proto_library(
     name = "optimization_csharp_proto",
+    extra_opts = [],
     deps = [":optimization_proto"],
 )
 
diff --git a/google/cloud/optimization/v1/fleet_routing.proto b/google/cloud/optimization/v1/fleet_routing.proto
@@ -1124,6 +1124,32 @@ message ShipmentTypeRequirement {
   RequirementMode requirement_mode = 3;
 }
 
+// Encapsulates a set of optional conditions to satisfy when calculating
+// vehicle routes. This is similar to `RouteModifiers` in the Google Maps
+// Platform API; see:
+// https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteModifiers.
+message RouteModifiers {
+  // Specifies whether to avoid toll roads where reasonable. Preference will be
+  // given to routes not containing toll roads. Applies only to motorized travel
+  // modes.
+  bool avoid_tolls = 2;
+
+  // Specifies whether to avoid highways where reasonable. Preference will be
+  // given to routes not containing highways. Applies only to motorized travel
+  // modes.
+  bool avoid_highways = 3;
+
+  // Specifies whether to avoid ferries where reasonable. Preference will be
+  // given to routes not containing travel by ferries. Applies only to motorized
+  // travel modes.
+  bool avoid_ferries = 4;
+
+  // Optional. Specifies whether to avoid navigating indoors where reasonable.
+  // Preference will be given to routes not containing indoor navigation.
+  // Applies only to the `WALKING` travel mode.
+  bool avoid_indoor = 5 [(google.api.field_behavior) = OPTIONAL];
+}
+
 // Models a vehicle in a shipment problem. Solving a shipment problem will
 // build a route starting from `start_location` and ending at `end_location`
 // for this vehicle. A route is a sequence of visits (see `ShipmentRoute`).
@@ -1264,6 +1290,10 @@ message Vehicle {
   // speed. See also `travel_duration_multiple`.
   TravelMode travel_mode = 1;
 
+  // Optional. A set of conditions to satisfy that affect the way routes are
+  // calculated for the given vehicle.
+  RouteModifiers route_modifiers = 2 [(google.api.field_behavior) = OPTIONAL];
+
   // Geographic location where the vehicle starts before picking up any
   // shipments. If not specified, the vehicle starts at its first pickup.
   // If the shipment model has duration and distance matrices, `start_location`
@@ -2696,6 +2726,13 @@ message OptimizeToursValidationError {
   //     * VISIT_REQUEST_DURATION_NEGATIVE_OR_NAN = 4404;
   //     * VISIT_REQUEST_DURATION_EXCEEDS_GLOBAL_DURATION = 4405;
   // * PRECEDENCE_ERROR = 46;
+  //     * PRECEDENCE_RULE_MISSING_FIRST_INDEX = 4600;
+  //     * PRECEDENCE_RULE_MISSING_SECOND_INDEX = 4601;
+  //     * PRECEDENCE_RULE_FIRST_INDEX_OUT_OF_BOUNDS = 4602;
+  //     * PRECEDENCE_RULE_SECOND_INDEX_OUT_OF_BOUNDS = 4603;
+  //     * PRECEDENCE_RULE_DUPLICATE_INDEX = 4604;
+  //     * PRECEDENCE_RULE_INEXISTENT_FIRST_VISIT_REQUEST = 4605;
+  //     * PRECEDENCE_RULE_INEXISTENT_SECOND_VISIT_REQUEST = 4606;
   // * BREAK_ERROR = 48;
   //     * BREAK_RULE_EMPTY = 4800;
   //     * BREAK_REQUEST_UNSPECIFIED_DURATION = 4801;
