@googlemaps/routeoptimization 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.2.0](https://github.com/googleapis/google-cloud-node/compare/routeoptimization-v0.1.0...routeoptimization-v0.2.0) (2024-09-24)
+
+
+### Features
+
+* [routeoptimization] minor fields and documentation update ([#5677](https://github.com/googleapis/google-cloud-node/issues/5677)) ([90a7e94](https://github.com/googleapis/google-cloud-node/commit/90a7e94a18e2472fd3e942c1006c0d53b5ab33fb))
+
 ## 0.1.0 (2024-05-23)
 
 

package/README.md

@@ -44,7 +44,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 1.  [Select or create a Cloud Platform project][projects].
 1.  [Enable billing for your project][billing].
 1.  [Enable the Route Optimization API API][enable_api].
-1.  [Set up authentication with a service account][auth] so you can access the
+1.  [Set up authentication][auth] so you can access the
     API from your local workstation.
 
 ### Installing the client library
@@ -362,4 +362,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
 [projects]: https://console.cloud.google.com/project
 [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
 [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=routeoptimization.googleapis.com
-[auth]: https://cloud.google.com/docs/authentication/getting-started
+[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local

package/build/protos/google/maps/routeoptimization/v1/route_optimization_service.proto

@@ -85,11 +85,23 @@ service RouteOptimization {
   //
   // This method is a Long Running Operation (LRO). The inputs for optimization
   // (`OptimizeToursRequest` messages) and outputs (`OptimizeToursResponse`
-  // messages) are read/written from/to Cloud Storage in user-specified
+  // messages) are read from and written to Cloud Storage in user-specified
   // format. Like the `OptimizeTours` method, each `OptimizeToursRequest`
   // contains a `ShipmentModel` and returns an `OptimizeToursResponse`
-  // containing `ShipmentRoute`s, which are a set of routes to be performed by
-  // vehicles minimizing the overall cost.
+  // containing `ShipmentRoute` fields, which are a set of routes to be
+  // performed by vehicles minimizing the overall cost.
+  //
+  // The user can poll `operations.get` to check the status of the LRO:
+  //
+  // If the LRO `done` field is false, then at least one request is still
+  // being processed. Other requests may have completed successfully and their
+  // results are available in Cloud Storage.
+  //
+  // If the LRO's `done` field is true, then all requests have been processed.
+  // Any successfully processed requests will have their results available in
+  // Cloud Storage. Any requests that failed will not have their results
+  // available in Cloud Storage. If the LRO's `error` field is set, then it
+  // contains the error from one of the failed requests.
   rpc BatchOptimizeTours(BatchOptimizeToursRequest)
       returns (google.longrunning.Operation) {
     option (google.api.http) = {
@@ -157,7 +169,8 @@ message OptimizeToursRequest {
   // [max_validation_errors][google.maps.routeoptimization.v1.OptimizeToursRequest.max_validation_errors]
   // to cap the number of errors returned.
   enum SolvingMode {
-    // Solve the model.
+    // Solve the model. Warnings may be issued in
+    // [OptimizeToursResponse.validation_errors][google.cloud.optimization.v1.OptimizeToursResponse.validation_errors].
     DEFAULT_SOLVE = 0;
 
     // Only validates the model without solving it: populates as many
@@ -361,7 +374,7 @@ message OptimizeToursRequest {
   // If true, polylines will be populated in response `ShipmentRoute`s.
   bool populate_polylines = 12;
 
-  // If true, polylines will be populated in response
+  // If true, polylines and route tokens will be populated in response
   // [ShipmentRoute.transitions][google.maps.routeoptimization.v1.ShipmentRoute.transitions].
   bool populate_transition_polylines = 13;
 
@@ -456,7 +469,8 @@ message OptimizeToursResponse {
   // List of all the validation errors that we were able to detect
   // independently. See the "MULTIPLE ERRORS" explanation for the
   // [OptimizeToursValidationError][google.maps.routeoptimization.v1.OptimizeToursValidationError]
-  // message.
+  // message. Instead of errors, this will include warnings in the case
+  // `solving_mode` is `DEFAULT_SOLVE`.
   repeated OptimizeToursValidationError validation_errors = 5;
 
   // Duration, distance and usage metrics for this solution.
@@ -1008,6 +1022,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 Routes Preferred 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`).
@@ -1152,6 +1192,10 @@ message Vehicle {
   // speed. See also `travel_duration_multiple`.
   TravelMode travel_mode = 1;
 
+  // A set of conditions to satisfy that affect the way routes are calculated
+  // for the given vehicle.
+  RouteModifiers route_modifiers = 2;
+
   // 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`
@@ -1353,8 +1397,9 @@ message Vehicle {
 // [ShipmentModel.global_end_time][google.maps.routeoptimization.v1.ShipmentModel.global_end_time])
 // and should respect:
 // ```
-//   0 <= `start_time` <= `soft_start_time` <= `end_time` and
-//   0 <= `start_time` <= `soft_end_time` <= `end_time`.
+//   0 <= `start_time` <= `end_time` and
+//   0 <= `start_time` <= `soft_start_time` and
+//   0 <= `soft_end_time` <= `end_time`.
 // ```
 message TimeWindow {
   // The hard time window start time. If unspecified it will be set to
@@ -1416,6 +1461,15 @@ message DistanceLimit {
   // nonnegative.
   optional int64 soft_max_meters = 2;
 
+  // Cost per kilometer incurred, increasing up to `soft_max_meters`, with
+  // formula:
+  // ```
+  //   min(distance_meters, soft_max_meters) / 1000.0 *
+  //   cost_per_kilometer_below_soft_max.
+  // ```
+  // This cost is not supported in `route_distance_limit`.
+  optional double cost_per_kilometer_below_soft_max = 4;
+
   // Cost per kilometer incurred if distance is above `soft_max_meters` limit.
   // The additional cost is 0 if the distance is under the limit, otherwise the
   // formula used to compute the cost is the following:
@@ -1794,6 +1848,17 @@ message ShipmentRoute {
     // is set to true.
     EncodedPolyline route_polyline = 9;
 
+    // Output only. An opaque token that can be passed to [Navigation
+    // SDK](https://developers.google.com/maps/documentation/navigation) to
+    // reconstruct the route during navigation, and, in the event of rerouting,
+    // honor the original intention when the route was created. Treat this token
+    // as an opaque blob.  Don't compare its value across requests as its value
+    // may change even if the service returns the exact same route. This field
+    // is only populated if [populate_transition_polylines]
+    // [google.maps.routeoptimization.v1.OptimizeToursRequest.populate_transition_polylines]
+    // is set to true.
+    string route_token = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
+
     // Vehicle loads during this transition, for each type that either appears
     // in this vehicle's
     // [Vehicle.load_limits][google.maps.routeoptimization.v1.Vehicle.load_limits],
@@ -1947,8 +2012,7 @@ message SkippedShipment {
     // particular, it gives no indication of whether a given reason will
     // appear before another in the solution, if both apply.
     enum Code {
-      // This should never be used. If we are unable to understand why a
-      // shipment was skipped, we simply return an empty set of reasons.
+      // This should never be used.
       CODE_UNSPECIFIED = 0;
 
       // There is no vehicle in the model making all shipments infeasible.
@@ -2011,7 +2075,8 @@ message SkippedShipment {
   string label = 2;
 
   // A list of reasons that explain why the shipment was skipped. See comment
-  // above `Reason`.
+  // above `Reason`. If we are unable to understand why a shipment was skipped,
+  // reasons will not be set.
   repeated Reason reasons = 3;
 }
 
@@ -2127,7 +2192,8 @@ message InjectedSolutionConstraint {
         RELAX_VISIT_TIMES_AFTER_THRESHOLD = 1;
 
         // Same as `RELAX_VISIT_TIMES_AFTER_THRESHOLD`, but the visit sequence
-        // is also relaxed: visits remain simply bound to their vehicle.
+        // is also relaxed: visits can only be performed by this vehicle, but
+        // can potentially become unperformed.
         RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD = 2;
 
         // Same as `RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD`, but the
@@ -2188,7 +2254,8 @@ message InjectedSolutionConstraint {
   repeated ConstraintRelaxation constraint_relaxations = 3;
 }
 
-// Describes an error encountered when validating an `OptimizeToursRequest`.
+// Describes an error or warning encountered when validating an
+// `OptimizeToursRequest`.
 message OptimizeToursValidationError {
   // Specifies a context for the validation error. A `FieldReference` always
   // refers to a given field in this file and follows the same hierarchical
@@ -2218,240 +2285,21 @@ message OptimizeToursValidationError {
   // A validation error is defined by the pair (`code`, `display_name`) which
   // are always present.
   //
-  // Other fields (below) provide more context about the error.
+  // The fields following this section provide more context about the error.
   //
   // *MULTIPLE ERRORS*:
   // When there are multiple errors, the validation process tries to output
   // several of them. Much like a compiler, this is an imperfect process. Some
   // validation errors will be "fatal", meaning that they stop the entire
   // validation process. This is the case for `display_name="UNSPECIFIED"`
-  // errors, among others. Some may cause the validation process to skip other
-  // errors.
+  // errors, among others. Some errors may cause the validation process to skip
+  // other errors.
   //
   // *STABILITY*:
   // `code` and `display_name` should be very stable. But new codes and
   // display names may appear over time, which may cause a given (invalid)
   // request to yield a different (`code`, `display_name`) pair because the new
-  // error hid the old one (see "MULTIPLE ERRORS").
-  //
-  // *REFERENCE*: A list of all (code, name) pairs:
-  //
-  // * UNSPECIFIED = 0;
-  // * VALIDATION_TIMEOUT_ERROR = 10; Validation couldn't be completed within
-  // the deadline.
-  //
-  // * REQUEST_OPTIONS_ERROR = 12;
-  //     * REQUEST_OPTIONS_INVALID_SOLVING_MODE = 1201;
-  //     * REQUEST_OPTIONS_INVALID_MAX_VALIDATION_ERRORS = 1203;
-  //     * REQUEST_OPTIONS_INVALID_GEODESIC_METERS_PER_SECOND = 1204;
-  //     * REQUEST_OPTIONS_GEODESIC_METERS_PER_SECOND_TOO_SMALL = 1205;
-  //     * REQUEST_OPTIONS_MISSING_GEODESIC_METERS_PER_SECOND = 1206;
-  //     * REQUEST_OPTIONS_POPULATE_PATHFINDER_TRIPS_AND_GEODESIC_DISTANCE
-  //       = 1207;
-  //     * REQUEST_OPTIONS_COST_MODEL_OPTIONS_AND_GEODESIC_DISTANCE = 1208;
-  //     * REQUEST_OPTIONS_TRAVEL_MODE_INCOMPATIBLE_WITH_TRAFFIC = 1211;
-  //     * REQUEST_OPTIONS_MULTIPLE_TRAFFIC_FLAVORS = 1212;
-  //     * REQUEST_OPTIONS_INVALID_TRAFFIC_FLAVOR = 1213;
-  //     * REQUEST_OPTIONS_TRAFFIC_ENABLED_WITHOUT_GLOBAL_START_TIME = 1214;
-  //     * REQUEST_OPTIONS_TRAFFIC_ENABLED_WITH_PRECEDENCES = 1215;
-  //     * REQUEST_OPTIONS_TRAFFIC_PREFILL_MODE_INVALID = 1216;
-  //     * REQUEST_OPTIONS_TRAFFIC_PREFILL_ENABLED_WITHOUT_TRAFFIC = 1217;
-  // * INJECTED_SOLUTION_ERROR = 20;
-  //     * INJECTED_SOLUTION_MISSING_LABEL = 2000;
-  //     * INJECTED_SOLUTION_DUPLICATE_LABEL = 2001;
-  //     * INJECTED_SOLUTION_AMBIGUOUS_INDEX = 2002;
-  //     * INJECTED_SOLUTION_INFEASIBLE_AFTER_GETTING_TRAVEL_TIMES = 2003;
-  //     * INJECTED_SOLUTION_TRANSITION_INCONSISTENT_WITH_ACTUAL_TRAVEL = 2004;
-  //     * INJECTED_SOLUTION_CONCURRENT_SOLUTION_TYPES = 2005;
-  //     * INJECTED_SOLUTION_MORE_THAN_ONE_PER_TYPE = 2006;
-  //     * INJECTED_SOLUTION_REFRESH_WITHOUT_POPULATE = 2008;
-  //     * INJECTED_SOLUTION_CONSTRAINED_ROUTE_PORTION_INFEASIBLE = 2010;
-  // * SHIPMENT_MODEL_ERROR = 22;
-  //     * SHIPMENT_MODEL_TOO_LARGE = 2200;
-  //     * SHIPMENT_MODEL_TOO_MANY_CAPACITY_TYPES = 2201;
-  //     * SHIPMENT_MODEL_GLOBAL_START_TIME_NEGATIVE_OR_NAN = 2202;
-  //     * SHIPMENT_MODEL_GLOBAL_END_TIME_TOO_LARGE_OR_NAN = 2203;
-  //     * SHIPMENT_MODEL_GLOBAL_START_TIME_AFTER_GLOBAL_END_TIME = 2204;
-  //     * SHIPMENT_MODEL_GLOBAL_DURATION_TOO_LONG = 2205;
-  //     * SHIPMENT_MODEL_MAX_ACTIVE_VEHICLES_NOT_POSITIVE = 2206;
-  //     * SHIPMENT_MODEL_DURATION_MATRIX_TOO_LARGE = 2207;
-  // * INDEX_ERROR = 24;
-  // * TAG_ERROR = 26;
-  // * TIME_WINDOW_ERROR = 28;
-  //     * TIME_WINDOW_INVALID_START_TIME = 2800;
-  //     * TIME_WINDOW_INVALID_END_TIME = 2801;
-  //     * TIME_WINDOW_INVALID_SOFT_START_TIME = 2802;
-  //     * TIME_WINDOW_INVALID_SOFT_END_TIME = 2803;
-  //     * TIME_WINDOW_OUTSIDE_GLOBAL_TIME_WINDOW = 2804;
-  //     * TIME_WINDOW_START_TIME_AFTER_END_TIME = 2805;
-  //     * TIME_WINDOW_INVALID_COST_PER_HOUR_BEFORE_SOFT_START_TIME = 2806;
-  //     * TIME_WINDOW_INVALID_COST_PER_HOUR_AFTER_SOFT_END_TIME = 2807;
-  //     * TIME_WINDOW_COST_BEFORE_SOFT_START_TIME_WITHOUT_SOFT_START_TIME
-  //       = 2808;
-  //     * TIME_WINDOW_COST_AFTER_SOFT_END_TIME_WITHOUT_SOFT_END_TIME = 2809;
-  //     * TIME_WINDOW_SOFT_START_TIME_WITHOUT_COST_BEFORE_SOFT_START_TIME
-  //       = 2810;
-  //     * TIME_WINDOW_SOFT_END_TIME_WITHOUT_COST_AFTER_SOFT_END_TIME = 2811;
-  //     * TIME_WINDOW_OVERLAPPING_ADJACENT_OR_EARLIER_THAN_PREVIOUS = 2812;
-  //     * TIME_WINDOW_START_TIME_AFTER_SOFT_START_TIME = 2813;
-  //     * TIME_WINDOW_SOFT_START_TIME_AFTER_END_TIME = 2814;
-  //     * TIME_WINDOW_START_TIME_AFTER_SOFT_END_TIME = 2815;
-  //     * TIME_WINDOW_SOFT_END_TIME_AFTER_END_TIME = 2816;
-  //     * TIME_WINDOW_COST_BEFORE_SOFT_START_TIME_SET_AND_MULTIPLE_WINDOWS
-  //       = 2817;
-  //     * TIME_WINDOW_COST_AFTER_SOFT_END_TIME_SET_AND_MULTIPLE_WINDOWS = 2818;
-  //     * TRANSITION_ATTRIBUTES_ERROR = 30;
-  //     * TRANSITION_ATTRIBUTES_INVALID_COST = 3000;
-  //     * TRANSITION_ATTRIBUTES_INVALID_COST_PER_KILOMETER = 3001;
-  //     * TRANSITION_ATTRIBUTES_DUPLICATE_TAG_PAIR = 3002;
-  //     * TRANSITION_ATTRIBUTES_DISTANCE_LIMIT_MAX_METERS_UNSUPPORTED = 3003;
-  //     * TRANSITION_ATTRIBUTES_UNSPECIFIED_SOURCE_TAGS = 3004;
-  //     * TRANSITION_ATTRIBUTES_CONFLICTING_SOURCE_TAGS_FIELDS = 3005;
-  //     * TRANSITION_ATTRIBUTES_UNSPECIFIED_DESTINATION_TAGS = 3006;
-  //     * TRANSITION_ATTRIBUTES_CONFLICTING_DESTINATION_TAGS_FIELDS = 3007;
-  //     * TRANSITION_ATTRIBUTES_DELAY_DURATION_NEGATIVE_OR_NAN = 3008;
-  //     * TRANSITION_ATTRIBUTES_DELAY_DURATION_EXCEEDS_GLOBAL_DURATION = 3009;
-  // * AMOUNT_ERROR = 31;
-  //     * AMOUNT_NEGATIVE_VALUE = 3100;
-  // * LOAD_LIMIT_ERROR = 33;
-  //     * LOAD_LIMIT_INVALID_COST_ABOVE_SOFT_MAX = 3303;
-  //     * LOAD_LIMIT_SOFT_MAX_WITHOUT_COST_ABOVE_SOFT_MAX = 3304;
-  //     * LOAD_LIMIT_COST_ABOVE_SOFT_MAX_WITHOUT_SOFT_MAX = 3305;
-  //     * LOAD_LIMIT_NEGATIVE_SOFT_MAX = 3306;
-  //     * LOAD_LIMIT_MIXED_DEMAND_TYPE = 3307;
-  //     * LOAD_LIMIT_MAX_LOAD_NEGATIVE_VALUE = 3308;
-  //     * LOAD_LIMIT_SOFT_MAX_ABOVE_MAX = 3309;
-  // * INTERVAL_ERROR = 34;
-  //     * INTERVAL_MIN_EXCEEDS_MAX = 3401;
-  //     * INTERVAL_NEGATIVE_MIN = 3402;
-  //     * INTERVAL_NEGATIVE_MAX = 3403;
-  //     * INTERVAL_MIN_EXCEEDS_CAPACITY = 3404;
-  //     * INTERVAL_MAX_EXCEEDS_CAPACITY = 3405;
-  // * DISTANCE_LIMIT_ERROR = 36;
-  //     * DISTANCE_LIMIT_INVALID_COST_AFTER_SOFT_MAX = 3601;
-  //     * DISTANCE_LIMIT_SOFT_MAX_WITHOUT_COST_AFTER_SOFT_MAX = 3602;
-  //     * DISTANCE_LIMIT_COST_AFTER_SOFT_MAX_WITHOUT_SOFT_MAX = 3603;
-  //     * DISTANCE_LIMIT_NEGATIVE_MAX = 3604;
-  //     * DISTANCE_LIMIT_NEGATIVE_SOFT_MAX = 3605;
-  //     * DISTANCE_LIMIT_SOFT_MAX_LARGER_THAN_MAX = 3606;
-  // * DURATION_LIMIT_ERROR = 38;
-  //     * DURATION_LIMIT_MAX_DURATION_NEGATIVE_OR_NAN = 3800;
-  //     * DURATION_LIMIT_SOFT_MAX_DURATION_NEGATIVE_OR_NAN = 3801;
-  //     * DURATION_LIMIT_INVALID_COST_PER_HOUR_AFTER_SOFT_MAX = 3802;
-  //     * DURATION_LIMIT_SOFT_MAX_WITHOUT_COST_AFTER_SOFT_MAX = 3803;
-  //     * DURATION_LIMIT_COST_AFTER_SOFT_MAX_WITHOUT_SOFT_MAX = 3804;
-  //     * DURATION_LIMIT_QUADRATIC_SOFT_MAX_DURATION_NEGATIVE_OR_NAN = 3805;
-  //     * DURATION_LIMIT_INVALID_COST_AFTER_QUADRATIC_SOFT_MAX = 3806;
-  //     * DURATION_LIMIT_QUADRATIC_SOFT_MAX_WITHOUT_COST_PER_SQUARE_HOUR
-  //       = 3807;
-  //     * DURATION_LIMIT_COST_PER_SQUARE_HOUR_WITHOUT_QUADRATIC_SOFT_MAX
-  //       = 3808;
-  //     * DURATION_LIMIT_QUADRATIC_SOFT_MAX_WITHOUT_MAX = 3809;
-  //     * DURATION_LIMIT_SOFT_MAX_LARGER_THAN_MAX = 3810;
-  //     * DURATION_LIMIT_QUADRATIC_SOFT_MAX_LARGER_THAN_MAX = 3811;
-  //     * DURATION_LIMIT_DIFF_BETWEEN_MAX_AND_QUADRATIC_SOFT_MAX_TOO_LARGE
-  //       = 3812;
-  //     * DURATION_LIMIT_MAX_DURATION_EXCEEDS_GLOBAL_DURATION = 3813;
-  //     * DURATION_LIMIT_SOFT_MAX_DURATION_EXCEEDS_GLOBAL_DURATION = 3814;
-  //     * DURATION_LIMIT_QUADRATIC_SOFT_MAX_DURATION_EXCEEDS_GLOBAL_DURATION
-  //       = 3815;
-  // * SHIPMENT_ERROR = 40;
-  //     * SHIPMENT_PD_LIMIT_WITHOUT_PICKUP_AND_DELIVERY = 4014;
-  //     * SHIPMENT_PD_ABSOLUTE_DETOUR_LIMIT_DURATION_NEGATIVE_OR_NAN = 4000;
-  //     * SHIPMENT_PD_ABSOLUTE_DETOUR_LIMIT_DURATION_EXCEEDS_GLOBAL_DURATION
-  //       = 4001;
-  //     * SHIPMENT_PD_RELATIVE_DETOUR_LIMIT_INVALID = 4015;
-  //     * SHIPMENT_PD_DETOUR_LIMIT_AND_EXTRA_VISIT_DURATION = 4016;
-  //     * SHIPMENT_PD_TIME_LIMIT_DURATION_NEGATIVE_OR_NAN = 4002;
-  //     * SHIPMENT_PD_TIME_LIMIT_DURATION_EXCEEDS_GLOBAL_DURATION = 4003;
-  //     * SHIPMENT_EMPTY_SHIPMENT_TYPE = 4004;
-  //     * SHIPMENT_NO_PICKUP_NO_DELIVERY = 4005;
-  //     * SHIPMENT_INVALID_PENALTY_COST = 4006;
-  //     * SHIPMENT_ALLOWED_VEHICLE_INDEX_OUT_OF_BOUNDS = 4007;
-  //     * SHIPMENT_DUPLICATE_ALLOWED_VEHICLE_INDEX = 4008;
-  //     * SHIPMENT_INCONSISTENT_COST_FOR_VEHICLE_SIZE_WITHOUT_INDEX = 4009;
-  //     * SHIPMENT_INCONSISTENT_COST_FOR_VEHICLE_SIZE_WITH_INDEX = 4010;
-  //     * SHIPMENT_INVALID_COST_FOR_VEHICLE = 4011;
-  //     * SHIPMENT_COST_FOR_VEHICLE_INDEX_OUT_OF_BOUNDS = 4012;
-  //     * SHIPMENT_DUPLICATE_COST_FOR_VEHICLE_INDEX = 4013;
-  // * VEHICLE_ERROR = 42;
-  //     * VEHICLE_EMPTY_REQUIRED_OPERATOR_TYPE = 4200;
-  //     * VEHICLE_DUPLICATE_REQUIRED_OPERATOR_TYPE = 4201;
-  //     * VEHICLE_NO_OPERATOR_WITH_REQUIRED_OPERATOR_TYPE = 4202;
-  //     * VEHICLE_EMPTY_START_TAG = 4203;
-  //     * VEHICLE_DUPLICATE_START_TAG = 4204;
-  //     * VEHICLE_EMPTY_END_TAG = 4205;
-  //     * VEHICLE_DUPLICATE_END_TAG = 4206;
-  //     * VEHICLE_EXTRA_VISIT_DURATION_NEGATIVE_OR_NAN = 4207;
-  //     * VEHICLE_EXTRA_VISIT_DURATION_EXCEEDS_GLOBAL_DURATION = 4208;
-  //     * VEHICLE_EXTRA_VISIT_DURATION_EMPTY_KEY = 4209;
-  //     * VEHICLE_FIRST_SHIPMENT_INDEX_OUT_OF_BOUNDS = 4210;
-  //     * VEHICLE_FIRST_SHIPMENT_IGNORED = 4211;
-  //     * VEHICLE_FIRST_SHIPMENT_NOT_BOUND = 4212;
-  //     * VEHICLE_LAST_SHIPMENT_INDEX_OUT_OF_BOUNDS = 4213;
-  //     * VEHICLE_LAST_SHIPMENT_IGNORED = 4214;
-  //     * VEHICLE_LAST_SHIPMENT_NOT_BOUND = 4215;
-  //     * VEHICLE_IGNORED_WITH_USED_IF_ROUTE_IS_EMPTY = 4216;
-  //     * VEHICLE_INVALID_COST_PER_KILOMETER = 4217;
-  //     * VEHICLE_INVALID_COST_PER_HOUR = 4218;
-  //     * VEHICLE_INVALID_COST_PER_TRAVELED_HOUR = 4219;
-  //     * VEHICLE_INVALID_FIXED_COST = 4220;
-  //     * VEHICLE_INVALID_TRAVEL_DURATION_MULTIPLE = 4221;
-  //     * VEHICLE_TRAVEL_DURATION_MULTIPLE_WITH_SHIPMENT_PD_DETOUR_LIMITS
-  //       = 4223;
-  //     * VEHICLE_MATRIX_INDEX_WITH_SHIPMENT_PD_DETOUR_LIMITS = 4224;
-  //     * VEHICLE_MINIMUM_DURATION_LONGER_THAN_DURATION_LIMIT = 4222;
-  // * VISIT_REQUEST_ERROR = 44;
-  //     * VISIT_REQUEST_EMPTY_TAG = 4400;
-  //     * VISIT_REQUEST_DUPLICATE_TAG = 4401;
-  //     * VISIT_REQUEST_DURATION_NEGATIVE_OR_NAN = 4404;
-  //     * VISIT_REQUEST_DURATION_EXCEEDS_GLOBAL_DURATION = 4405;
-  // * PRECEDENCE_ERROR = 46;
-  // * BREAK_ERROR = 48;
-  //     * BREAK_RULE_EMPTY = 4800;
-  //     * BREAK_REQUEST_UNSPECIFIED_DURATION = 4801;
-  //     * BREAK_REQUEST_UNSPECIFIED_EARLIEST_START_TIME = 4802;
-  //     * BREAK_REQUEST_UNSPECIFIED_LATEST_START_TIME = 4803;
-  //     * BREAK_REQUEST_DURATION_NEGATIVE_OR_NAN = 4804; = 4804;
-  //     * BREAK_REQUEST_LATEST_START_TIME_BEFORE_EARLIEST_START_TIME = 4805;
-  //     * BREAK_REQUEST_EARLIEST_START_TIME_BEFORE_GLOBAL_START_TIME = 4806;
-  //     * BREAK_REQUEST_LATEST_END_TIME_AFTER_GLOBAL_END_TIME = 4807;
-  //     * BREAK_REQUEST_NON_SCHEDULABLE = 4808;
-  //     * BREAK_FREQUENCY_MAX_INTER_BREAK_DURATION_NEGATIVE_OR_NAN = 4809;
-  //     * BREAK_FREQUENCY_MIN_BREAK_DURATION_NEGATIVE_OR_NAN = 4810;
-  //     * BREAK_FREQUENCY_MIN_BREAK_DURATION_EXCEEDS_GLOBAL_DURATION = 4811;
-  //     * BREAK_FREQUENCY_MAX_INTER_BREAK_DURATION_EXCEEDS_GLOBAL_DURATION
-  //       = 4812;
-  //     * BREAK_REQUEST_DURATION_EXCEEDS_GLOBAL_DURATION = 4813;
-  //     * BREAK_FREQUENCY_MISSING_MAX_INTER_BREAK_DURATION = 4814;
-  //     * BREAK_FREQUENCY_MISSING_MIN_BREAK_DURATION = 4815;
-  // * SHIPMENT_TYPE_INCOMPATIBILITY_ERROR = 50;
-  //     * SHIPMENT_TYPE_INCOMPATIBILITY_EMPTY_TYPE = 5001;
-  //     * SHIPMENT_TYPE_INCOMPATIBILITY_LESS_THAN_TWO_TYPES = 5002;
-  //     * SHIPMENT_TYPE_INCOMPATIBILITY_DUPLICATE_TYPE = 5003;
-  //     * SHIPMENT_TYPE_INCOMPATIBILITY_INVALID_INCOMPATIBILITY_MODE = 5004;
-  //     * SHIPMENT_TYPE_INCOMPATIBILITY_TOO_MANY_INCOMPATIBILITIES = 5005;
-  // * SHIPMENT_TYPE_REQUIREMENT_ERROR = 52;
-  //     * SHIPMENT_TYPE_REQUIREMENT_NO_REQUIRED_TYPE = 52001;
-  //     * SHIPMENT_TYPE_REQUIREMENT_NO_DEPENDENT_TYPE = 52002;
-  //     * SHIPMENT_TYPE_REQUIREMENT_INVALID_REQUIREMENT_MODE = 52003;
-  //     * SHIPMENT_TYPE_REQUIREMENT_TOO_MANY_REQUIREMENTS = 52004;
-  //     * SHIPMENT_TYPE_REQUIREMENT_EMPTY_REQUIRED_TYPE = 52005;
-  //     * SHIPMENT_TYPE_REQUIREMENT_DUPLICATE_REQUIRED_TYPE = 52006;
-  //     * SHIPMENT_TYPE_REQUIREMENT_NO_REQUIRED_TYPE_FOUND = 52007;
-  //     * SHIPMENT_TYPE_REQUIREMENT_EMPTY_DEPENDENT_TYPE = 52008;
-  //     * SHIPMENT_TYPE_REQUIREMENT_DUPLICATE_DEPENDENT_TYPE = 52009;
-  //     * SHIPMENT_TYPE_REQUIREMENT_SELF_DEPENDENT_TYPE = 52010;
-  //     * SHIPMENT_TYPE_REQUIREMENT_GRAPH_HAS_CYCLES = 52011;
-  // * VEHICLE_OPERATOR_ERROR = 54;
-  //     * VEHICLE_OPERATOR_EMPTY_TYPE = 5400;
-  //     * VEHICLE_OPERATOR_MULTIPLE_START_TIME_WINDOWS = 5401;
-  //     * VEHICLE_OPERATOR_SOFT_START_TIME_WINDOW = 5402;
-  //     * VEHICLE_OPERATOR_MULTIPLE_END_TIME_WINDOWS = 5403;
-  //     * VEHICLE_OPERATOR_SOFT_END_TIME_WINDOW = 5404;
-  // * DURATION_SECONDS_MATRIX_ERROR = 56;
-  //     * DURATION_SECONDS_MATRIX_DURATION_NEGATIVE_OR_NAN = 5600;
-  //     * DURATION_SECONDS_MATRIX_DURATION_EXCEEDS_GLOBAL_DURATION = 5601;
+  // error hid the old one. For example, see "MULTIPLE ERRORS".
   int32 code = 1;
 
   // The error display name.

package/build/protos/protos.d.ts

@@ -2144,6 +2144,121 @@ export namespace google {
                     }
                 }
 
+                /** Properties of a RouteModifiers. */
+                interface IRouteModifiers {
+
+                    /** RouteModifiers avoidTolls */
+                    avoidTolls?: (boolean|null);
+
+                    /** RouteModifiers avoidHighways */
+                    avoidHighways?: (boolean|null);
+
+                    /** RouteModifiers avoidFerries */
+                    avoidFerries?: (boolean|null);
+
+                    /** RouteModifiers avoidIndoor */
+                    avoidIndoor?: (boolean|null);
+                }
+
+                /** Represents a RouteModifiers. */
+                class RouteModifiers implements IRouteModifiers {
+
+                    /**
+                     * Constructs a new RouteModifiers.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: google.maps.routeoptimization.v1.IRouteModifiers);
+
+                    /** RouteModifiers avoidTolls. */
+                    public avoidTolls: boolean;
+
+                    /** RouteModifiers avoidHighways. */
+                    public avoidHighways: boolean;
+
+                    /** RouteModifiers avoidFerries. */
+                    public avoidFerries: boolean;
+
+                    /** RouteModifiers avoidIndoor. */
+                    public avoidIndoor: boolean;
+
+                    /**
+                     * Creates a new RouteModifiers instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns RouteModifiers instance
+                     */
+                    public static create(properties?: google.maps.routeoptimization.v1.IRouteModifiers): google.maps.routeoptimization.v1.RouteModifiers;
+
+                    /**
+                     * Encodes the specified RouteModifiers message. Does not implicitly {@link google.maps.routeoptimization.v1.RouteModifiers.verify|verify} messages.
+                     * @param message RouteModifiers message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: google.maps.routeoptimization.v1.IRouteModifiers, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified RouteModifiers message, length delimited. Does not implicitly {@link google.maps.routeoptimization.v1.RouteModifiers.verify|verify} messages.
+                     * @param message RouteModifiers message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: google.maps.routeoptimization.v1.IRouteModifiers, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes a RouteModifiers message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns RouteModifiers
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.routeoptimization.v1.RouteModifiers;
+
+                    /**
+                     * Decodes a RouteModifiers message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns RouteModifiers
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.routeoptimization.v1.RouteModifiers;
+
+                    /**
+                     * Verifies a RouteModifiers message.
+                     * @param message Plain object to verify
+                     * @returns `null` if valid, otherwise the reason why it is not
+                     */
+                    public static verify(message: { [k: string]: any }): (string|null);
+
+                    /**
+                     * Creates a RouteModifiers message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns RouteModifiers
+                     */
+                    public static fromObject(object: { [k: string]: any }): google.maps.routeoptimization.v1.RouteModifiers;
+
+                    /**
+                     * Creates a plain object from a RouteModifiers message. Also converts values to other types if specified.
+                     * @param message RouteModifiers
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: google.maps.routeoptimization.v1.RouteModifiers, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this RouteModifiers to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+
+                    /**
+                     * Gets the default type url for RouteModifiers
+                     * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                     * @returns The default type url
+                     */
+                    public static getTypeUrl(typeUrlPrefix?: string): string;
+                }
+
                 /** Properties of a Vehicle. */
                 interface IVehicle {
 
@@ -2153,6 +2268,9 @@ export namespace google {
                     /** Vehicle travelMode */
                     travelMode?: (google.maps.routeoptimization.v1.Vehicle.TravelMode|keyof typeof google.maps.routeoptimization.v1.Vehicle.TravelMode|null);
 
+                    /** Vehicle routeModifiers */
+                    routeModifiers?: (google.maps.routeoptimization.v1.IRouteModifiers|null);
+
                     /** Vehicle startLocation */
                     startLocation?: (google.type.ILatLng|null);
 
@@ -2238,6 +2356,9 @@ export namespace google {
                     /** Vehicle travelMode. */
                     public travelMode: (google.maps.routeoptimization.v1.Vehicle.TravelMode|keyof typeof google.maps.routeoptimization.v1.Vehicle.TravelMode);
 
+                    /** Vehicle routeModifiers. */
+                    public routeModifiers?: (google.maps.routeoptimization.v1.IRouteModifiers|null);
+
                     /** Vehicle startLocation. */
                     public startLocation?: (google.type.ILatLng|null);
 
@@ -2907,6 +3028,9 @@ export namespace google {
                     /** DistanceLimit softMaxMeters */
                     softMaxMeters?: (number|Long|string|null);
 
+                    /** DistanceLimit costPerKilometerBelowSoftMax */
+                    costPerKilometerBelowSoftMax?: (number|null);
+
                     /** DistanceLimit costPerKilometerAboveSoftMax */
                     costPerKilometerAboveSoftMax?: (number|null);
                 }
@@ -2926,6 +3050,9 @@ export namespace google {
                     /** DistanceLimit softMaxMeters. */
                     public softMaxMeters?: (number|Long|string|null);
 
+                    /** DistanceLimit costPerKilometerBelowSoftMax. */
+                    public costPerKilometerBelowSoftMax?: (number|null);
+
                     /** DistanceLimit costPerKilometerAboveSoftMax. */
                     public costPerKilometerAboveSoftMax?: (number|null);
 
@@ -2935,6 +3062,9 @@ export namespace google {
                     /** DistanceLimit _softMaxMeters. */
                     public _softMaxMeters?: "softMaxMeters";
 
+                    /** DistanceLimit _costPerKilometerBelowSoftMax. */
+                    public _costPerKilometerBelowSoftMax?: "costPerKilometerBelowSoftMax";
+
                     /** DistanceLimit _costPerKilometerAboveSoftMax. */
                     public _costPerKilometerAboveSoftMax?: "costPerKilometerAboveSoftMax";
 
@@ -4025,6 +4155,9 @@ export namespace google {
                         /** Transition routePolyline */
                         routePolyline?: (google.maps.routeoptimization.v1.ShipmentRoute.IEncodedPolyline|null);
 
+                        /** Transition routeToken */
+                        routeToken?: (string|null);
+
                         /** Transition vehicleLoads */
                         vehicleLoads?: ({ [k: string]: google.maps.routeoptimization.v1.ShipmentRoute.IVehicleLoad }|null);
                     }
@@ -4065,6 +4198,9 @@ export namespace google {
                         /** Transition routePolyline. */
                         public routePolyline?: (google.maps.routeoptimization.v1.ShipmentRoute.IEncodedPolyline|null);
 
+                        /** Transition routeToken. */
+                        public routeToken: string;
+
                         /** Transition vehicleLoads. */
                         public vehicleLoads: { [k: string]: google.maps.routeoptimization.v1.ShipmentRoute.IVehicleLoad };