proto_docs/google/cloud/optimization/v1/fleet_routing.rb in google-cloud-optimization-v1-0.4.1 vs proto_docs/google/cloud/optimization/v1/fleet_routing.rb in google-cloud-optimization-v1-0.5.0

- old
+ new

@@ -42,19 +42,10 @@ # @return [::Google::Cloud::Optimization::V1::ShipmentModel] # Shipment model to solve. # @!attribute [rw] solving_mode # @return [::Google::Cloud::Optimization::V1::OptimizeToursRequest::SolvingMode] # By default, the solving mode is `DEFAULT_SOLVE` (0). - # @!attribute [rw] max_validation_errors - # @return [::Integer] - # Truncates the number of validation errors returned. These errors are - # typically attached to an INVALID_ARGUMENT error payload as a BadRequest - # error detail (https://cloud.google.com/apis/design/errors#error_details), - # unless solving_mode=VALIDATE_ONLY: see the - # {::Google::Cloud::Optimization::V1::OptimizeToursResponse#validation_errors OptimizeToursResponse.validation_errors} - # field. - # This defaults to 100 and is capped at 10,000. # @!attribute [rw] search_mode # @return [::Google::Cloud::Optimization::V1::OptimizeToursRequest::SearchMode] # Search mode used to solve the request. # @!attribute [rw] injected_first_solution_routes # @return [::Array<::Google::Cloud::Optimization::V1::ShipmentRoute>] @@ -216,10 +207,19 @@ # @!attribute [rw] geodesic_meters_per_second # @return [::Float] # When `use_geodesic_distances` is true, this field must be set and defines # the speed applied to compute travel times. Its value must be at least 1.0 # meters/seconds. + # @!attribute [rw] max_validation_errors + # @return [::Integer] + # Truncates the number of validation errors returned. These errors are + # typically attached to an INVALID_ARGUMENT error payload as a BadRequest + # error detail (https://cloud.google.com/apis/design/errors#error_details), + # unless solving_mode=VALIDATE_ONLY: see the + # {::Google::Cloud::Optimization::V1::OptimizeToursResponse#validation_errors OptimizeToursResponse.validation_errors} + # field. + # This defaults to 100 and is capped at 10,000. # @!attribute [rw] label # @return [::String] # Label that may be used to identify this request, reported back in the # {::Google::Cloud::Optimization::V1::OptimizeToursResponse#request_label OptimizeToursResponse.request_label}. # @!attribute [rw] populate_travel_step_polylines @@ -247,16 +247,24 @@ # {::Google::Cloud::Optimization::V1::OptimizeToursResponse#validation_errors OptimizeToursResponse.validation_errors} # as possible. VALIDATE_ONLY = 1 # Only populates + # {::Google::Cloud::Optimization::V1::OptimizeToursResponse#validation_errors OptimizeToursResponse.validation_errors} + # or # {::Google::Cloud::Optimization::V1::OptimizeToursResponse#skipped_shipments OptimizeToursResponse.skipped_shipments}, # and doesn't actually solve the rest of the request (`status` and `routes` # are unset in the response). + # If infeasibilities in `injected_solution_constraint` routes are detected + # they are populated in the + # {::Google::Cloud::Optimization::V1::OptimizeToursResponse#validation_errors OptimizeToursResponse.validation_errors} + # field and + # {::Google::Cloud::Optimization::V1::OptimizeToursResponse#skipped_shipments OptimizeToursResponse.skipped_shipments} + # is left empty. # # *IMPORTANT*: not all infeasible shipments are returned here, but only the - # ones that are detected as infeasible as a preprocessing. + # ones that are detected as infeasible during preprocessing. DETECT_SOME_INFEASIBLE_SHIPMENTS = 2 end # Mode defining the behavior of the search, trading off latency versus # solution quality. In all modes, the global request deadline is enforced. @@ -1456,10 +1464,13 @@ # Unspecified travel mode, equivalent to `DRIVING`. TRAVEL_MODE_UNSPECIFIED = 0 # Travel mode corresponding to driving directions (car, ...). DRIVING = 1 + + # Travel mode corresponding to walking directions. + WALKING = 2 end # Policy on how a vehicle can be unloaded. Applies only to shipments having # both a pickup and a delivery. # @@ -1585,10 +1596,19 @@ # results in a cost which adds up to other costs defined in the model, # with the same unit. # # If defined soft_max_meters must be less than max_meters and must be # nonnegative. + # @!attribute [rw] cost_per_kilometer_below_soft_max + # @return [::Float] + # 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`. # @!attribute [rw] cost_per_kilometer_above_soft_max # @return [::Float] # 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: @@ -2388,14 +2408,14 @@ # @return [::Google::Protobuf::Duration] # Total visit duration for a route or a solution. # @!attribute [rw] total_duration # @return [::Google::Protobuf::Duration] # The total duration should be equal to the sum of all durations above. - # For routes, it also corresponds to + # For routes, it also corresponds to: # {::Google::Cloud::Optimization::V1::ShipmentRoute#vehicle_end_time ShipmentRoute.vehicle_end_time} - # - - # {::Google::Cloud::Optimization::V1::ShipmentRoute#vehicle_start_time ShipmentRoute.vehicle_start_time}. + # `-` + # {::Google::Cloud::Optimization::V1::ShipmentRoute#vehicle_start_time ShipmentRoute.vehicle_start_time} # @!attribute [rw] travel_distance_meters # @return [::Float] # Total travel distance for a route or a solution. # @!attribute [rw] max_loads # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::ShipmentRoute::VehicleLoad}] @@ -2561,11 +2581,12 @@ # must be observed: no visit can be inserted between them or before # them. 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 # vehicle is also relaxed: visits are completely free at or after the # threshold time and can potentially become unperformed. @@ -2626,9 +2647,10 @@ # * 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;