lib/google/cloud/optimization/v1/fleet_routing/client.rb in google-cloud-optimization-v1-0.2.0 vs lib/google/cloud/optimization/v1/fleet_routing/client.rb in google-cloud-optimization-v1-0.2.1

- old
+ new

@@ -228,11 +228,11 @@ # @param model [::Google::Cloud::Optimization::V1::ShipmentModel, ::Hash] # Shipment model to solve. # @param solving_mode [::Google::Cloud::Optimization::V1::OptimizeToursRequest::SolvingMode] # By default, the solving mode is `DEFAULT_SOLVE` (0). # @param max_validation_errors [::Integer] - # Truncates the number of validation errors returned. Those errors are + # 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. @@ -259,12 +259,13 @@ # a shipment may be performed. # * for all routes, times are increasing (i.e., `vehicle_start_time # <= visits[0].start_time <= visits[1].start_time ... # <= vehicle_end_time`). # * a shipment may only be performed on a vehicle that is allowed. A - # vehicle is allowed if {::Google::Cloud::Optimization::V1::Shipment#allowed_vehicle_indices Shipment.allowed_vehicle_indices} is empty or - # its `vehicle_index` is included in + # vehicle is allowed if + # {::Google::Cloud::Optimization::V1::Shipment#allowed_vehicle_indices Shipment.allowed_vehicle_indices} + # is empty or its `vehicle_index` is included in # {::Google::Cloud::Optimization::V1::Shipment#allowed_vehicle_indices Shipment.allowed_vehicle_indices}. # # If the injected solution is not feasible, a validation error is not # necessarily returned and an error indicating infeasibility may be returned # instead. @@ -295,20 +296,31 @@ # Polylines are still populated between all visits in all non-empty routes # regardless of whether the related shipments or vehicles are ignored. # @param interpret_injected_solutions_using_labels [::Boolean] # If true: # - # * uses {::Google::Cloud::Optimization::V1::ShipmentRoute#vehicle_label ShipmentRoute.vehicle_label} instead of `vehicle_index` to + # * uses + # {::Google::Cloud::Optimization::V1::ShipmentRoute#vehicle_label ShipmentRoute.vehicle_label} + # instead of `vehicle_index` to # match routes in an injected solution with vehicles in the request; - # reuses the mapping of original {::Google::Cloud::Optimization::V1::ShipmentRoute#vehicle_index ShipmentRoute.vehicle_index} to new - # {::Google::Cloud::Optimization::V1::ShipmentRoute#vehicle_index ShipmentRoute.vehicle_index} to update + # reuses the mapping of original + # {::Google::Cloud::Optimization::V1::ShipmentRoute#vehicle_index ShipmentRoute.vehicle_index} + # to new + # {::Google::Cloud::Optimization::V1::ShipmentRoute#vehicle_index ShipmentRoute.vehicle_index} + # to update # {::Google::Cloud::Optimization::V1::InjectedSolutionConstraint::ConstraintRelaxation#vehicle_indices ConstraintRelaxation.vehicle_indices} # if non-empty, but the mapping must be unambiguous (i.e., multiple # `ShipmentRoute`s must not share the same original `vehicle_index`). - # * uses {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit#shipment_label ShipmentRoute.Visit.shipment_label} instead of `shipment_index` + # * uses + # {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit#shipment_label ShipmentRoute.Visit.shipment_label} + # instead of `shipment_index` # to match visits in an injected solution with shipments in the request; - # * uses {::Google::Cloud::Optimization::V1::SkippedShipment#label SkippedShipment.label} instead of {::Google::Cloud::Optimization::V1::SkippedShipment#index SkippedShipment.index} to + # * uses + # {::Google::Cloud::Optimization::V1::SkippedShipment#label SkippedShipment.label} + # instead of + # {::Google::Cloud::Optimization::V1::SkippedShipment#index SkippedShipment.index} + # to # match skipped shipments in the injected solution with request # shipments. # # This interpretation applies to the `injected_first_solution_routes`, # `injected_solution_constraint`, and `refresh_details_routes` fields. @@ -317,42 +329,49 @@ # vehicles have been removed from or added to the request. # # If true, labels in the following categories must appear at most once in # their category: # - # * {::Google::Cloud::Optimization::V1::Vehicle#label Vehicle.label} in the request; - # * {::Google::Cloud::Optimization::V1::Shipment#label Shipment.label} in the request; + # * {::Google::Cloud::Optimization::V1::Vehicle#label Vehicle.label} in the + # request; + # * {::Google::Cloud::Optimization::V1::Shipment#label Shipment.label} in the + # request; # * {::Google::Cloud::Optimization::V1::ShipmentRoute#vehicle_label ShipmentRoute.vehicle_label} in the injected solution; # * {::Google::Cloud::Optimization::V1::SkippedShipment#label SkippedShipment.label} and {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit#shipment_label ShipmentRoute.Visit.shipment_label} in # the injected solution (except pickup/delivery visit pairs, whose # `shipment_label` must appear twice). # # If a `vehicle_label` in the injected solution does not correspond to a # request vehicle, the corresponding route is removed from the solution # along with its visits. If a `shipment_label` in the injected solution does # not correspond to a request shipment, the corresponding visit is removed - # from the solution. If a {::Google::Cloud::Optimization::V1::SkippedShipment#label SkippedShipment.label} in the injected solution - # does not correspond to a request shipment, the `SkippedShipment` is removed - # from the solution. + # from the solution. If a + # {::Google::Cloud::Optimization::V1::SkippedShipment#label SkippedShipment.label} + # in the injected solution does not correspond to a request shipment, the + # `SkippedShipment` is removed from the solution. # # Removing route visits or entire routes from an injected solution may # have an effect on the implied constraints, which may lead to change in # solution, validation errors, or infeasibility. # - # NOTE: The caller must ensure that each {::Google::Cloud::Optimization::V1::Vehicle#label Vehicle.label} - # (resp. {::Google::Cloud::Optimization::V1::Shipment#label Shipment.label}) uniquely identifies a vehicle (resp. shipment) - # entity used across the two relevant requests: the past request that - # produced the `OptimizeToursResponse` used in the injected solution and the - # current request that includes the injected solution. The uniqueness checks - # described above are not enough to guarantee this requirement. + # NOTE: The caller must ensure that each + # {::Google::Cloud::Optimization::V1::Vehicle#label Vehicle.label} (resp. + # {::Google::Cloud::Optimization::V1::Shipment#label Shipment.label}) uniquely + # identifies a vehicle (resp. shipment) entity used across the two relevant + # requests: the past request that produced the `OptimizeToursResponse` used + # in the injected solution and the current request that includes the injected + # solution. The uniqueness checks described above are not enough to guarantee + # this requirement. # @param consider_road_traffic [::Boolean] # Consider traffic estimation in calculating `ShipmentRoute` fields # {::Google::Cloud::Optimization::V1::ShipmentRoute::Transition#travel_duration Transition.travel_duration}, # {::Google::Cloud::Optimization::V1::ShipmentRoute::Visit#start_time Visit.start_time}, # and `vehicle_end_time`; in setting the - # {::Google::Cloud::Optimization::V1::ShipmentRoute#has_traffic_infeasibilities ShipmentRoute.has_traffic_infeasibilities} field, and in calculating the - # {::Google::Cloud::Optimization::V1::OptimizeToursResponse#total_cost OptimizeToursResponse.total_cost} field. + # {::Google::Cloud::Optimization::V1::ShipmentRoute#has_traffic_infeasibilities ShipmentRoute.has_traffic_infeasibilities} + # field, and in calculating the + # {::Google::Cloud::Optimization::V1::OptimizeToursResponse#total_cost OptimizeToursResponse.total_cost} + # field. # @param populate_polylines [::Boolean] # If true, polylines will be populated in response `ShipmentRoute`s. # @param populate_transition_polylines [::Boolean] # If true, polylines will be populated in response # {::Google::Cloud::Optimization::V1::ShipmentRoute#transitions ShipmentRoute.transitions}. @@ -374,14 +393,16 @@ # meters/seconds. # @param label [::String] # Label that may be used to identify this request, reported back in the # {::Google::Cloud::Optimization::V1::OptimizeToursResponse#request_label OptimizeToursResponse.request_label}. # @param populate_travel_step_polylines [::Boolean] - # Deprecated: Use [OptimizeToursRequest.populate_transition_polylines][] instead. - # If true, polylines will be populated in response - # {::Google::Cloud::Optimization::V1::ShipmentRoute#transitions ShipmentRoute.transitions}. Note that in this case, the polylines will - # also be populated in the deprecated `travel_steps`. + # Deprecated: Use + # {::Google::Cloud::Optimization::V1::OptimizeToursRequest#populate_transition_polylines OptimizeToursRequest.populate_transition_polylines} + # instead. If true, polylines will be populated in response + # {::Google::Cloud::Optimization::V1::ShipmentRoute#transitions ShipmentRoute.transitions}. + # Note that in this case, the polylines will also be populated in the + # deprecated `travel_steps`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Optimization::V1::OptimizeToursResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # @@ -477,11 +498,11 @@ # # Format: `projects/{project-id}/locations/{location-id}`. # # If no location is specified, a region will be chosen automatically. # @param model_configs [::Array<::Google::Cloud::Optimization::V1::BatchOptimizeToursRequest::AsyncModelConfig, ::Hash>] - # Required. Input/Output information each purchase model, such as file paths and data - # formats. + # Required. Input/Output information each purchase model, such as file paths + # and data formats. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] #