Cloud Optimization V1 API - Class Google::Cloud::Optimization::V1::OptimizeToursRequest (v0.8.2)

Version 0.8.2

• 0.10.0 (latest)
• 0.9.2
• 0.8.2
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.1
• 0.1.1

Reference documentation and code samples for the Cloud Optimization V1 API class Google::Cloud::Optimization::V1::OptimizeToursRequest.

Request to be given to a tour optimization solver which defines the shipment model to solve as well as optimization parameters.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#allow_large_deadline_despite_interruption_risk

def allow_large_deadline_despite_interruption_risk() -> ::Boolean

Returns

• (::Boolean) — If this is set, then the request can have a deadline (see https://grpc.io/blog/deadlines) of up to 60 minutes. Otherwise, the maximum deadline is only 30 minutes. Note that long-lived requests have a significantly larger (but still small) risk of interruption.

#allow_large_deadline_despite_interruption_risk=

def allow_large_deadline_despite_interruption_risk=(value) -> ::Boolean

Parameter

• value (::Boolean) — If this is set, then the request can have a deadline (see https://grpc.io/blog/deadlines) of up to 60 minutes. Otherwise, the maximum deadline is only 30 minutes. Note that long-lived requests have a significantly larger (but still small) risk of interruption.

Returns

• (::Boolean) — If this is set, then the request can have a deadline (see https://grpc.io/blog/deadlines) of up to 60 minutes. Otherwise, the maximum deadline is only 30 minutes. Note that long-lived requests have a significantly larger (but still small) risk of interruption.

#consider_road_traffic

def consider_road_traffic() -> ::Boolean

Returns

• (::Boolean) — Consider traffic estimation in calculating ShipmentRoute fields Transition.travel_duration, Visit.start_time, and vehicle_end_time; in setting the ShipmentRoute.has_traffic_infeasibilities field, and in calculating the OptimizeToursResponse.total_cost field.

#consider_road_traffic=

def consider_road_traffic=(value) -> ::Boolean

Parameter

• value (::Boolean) — Consider traffic estimation in calculating ShipmentRoute fields Transition.travel_duration, Visit.start_time, and vehicle_end_time; in setting the ShipmentRoute.has_traffic_infeasibilities field, and in calculating the OptimizeToursResponse.total_cost field.

Returns

• (::Boolean) — Consider traffic estimation in calculating ShipmentRoute fields Transition.travel_duration, Visit.start_time, and vehicle_end_time; in setting the ShipmentRoute.has_traffic_infeasibilities field, and in calculating the OptimizeToursResponse.total_cost field.

#geodesic_meters_per_second

def geodesic_meters_per_second() -> ::Float

Returns

• (::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.

#geodesic_meters_per_second=

def geodesic_meters_per_second=(value) -> ::Float

Parameter

• value (::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.

Returns

• (::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.

#injected_first_solution_routes

def injected_first_solution_routes() -> ::Array<::Google::Cloud::Optimization::V1::ShipmentRoute>

Returns

• (::Array<::Google::Cloud::Optimization::V1::ShipmentRoute>) — Guide the optimization algorithm in finding a first solution that is similar to a previous solution.

  The model is constrained when the first solution is built. Any shipments not performed on a route are implicitly skipped in the first solution, but they may be performed in successive solutions.

  The solution must satisfy some basic validity assumptions:

  • for all routes, vehicle_index must be in range and not be duplicated.
  • for all visits, shipment_index and visit_request_index must be in range.
  • a shipment may only be referenced on one route.
  • the pickup of a pickup-delivery shipment must be performed before the delivery.
  • no more than one pickup alternative or delivery alternative of 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 Shipment.allowed_vehicle_indices is empty or its vehicle_index is included in 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.

#injected_first_solution_routes=

def injected_first_solution_routes=(value) -> ::Array<::Google::Cloud::Optimization::V1::ShipmentRoute>

Parameter

• value (::Array<::Google::Cloud::Optimization::V1::ShipmentRoute>) — Guide the optimization algorithm in finding a first solution that is similar to a previous solution.

  The model is constrained when the first solution is built. Any shipments not performed on a route are implicitly skipped in the first solution, but they may be performed in successive solutions.

  The solution must satisfy some basic validity assumptions:

  • for all routes, vehicle_index must be in range and not be duplicated.
  • for all visits, shipment_index and visit_request_index must be in range.
  • a shipment may only be referenced on one route.
  • the pickup of a pickup-delivery shipment must be performed before the delivery.
  • no more than one pickup alternative or delivery alternative of 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 Shipment.allowed_vehicle_indices is empty or its vehicle_index is included in 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.

Returns

• (::Array<::Google::Cloud::Optimization::V1::ShipmentRoute>) — Guide the optimization algorithm in finding a first solution that is similar to a previous solution.

  The model is constrained when the first solution is built. Any shipments not performed on a route are implicitly skipped in the first solution, but they may be performed in successive solutions.

  The solution must satisfy some basic validity assumptions:

  • for all routes, vehicle_index must be in range and not be duplicated.
  • for all visits, shipment_index and visit_request_index must be in range.
  • a shipment may only be referenced on one route.
  • the pickup of a pickup-delivery shipment must be performed before the delivery.
  • no more than one pickup alternative or delivery alternative of 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 Shipment.allowed_vehicle_indices is empty or its vehicle_index is included in 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.

#injected_solution_constraint

def injected_solution_constraint() -> ::Google::Cloud::Optimization::V1::InjectedSolutionConstraint

Returns

• (::Google::Cloud::Optimization::V1::InjectedSolutionConstraint) — Constrain the optimization algorithm to find a final solution that is similar to a previous solution. For example, this may be used to freeze portions of routes which have already been completed or which are to be completed but must not be modified.

  If the injected solution is not feasible, a validation error is not necessarily returned and an error indicating infeasibility may be returned instead.

#injected_solution_constraint=

def injected_solution_constraint=(value) -> ::Google::Cloud::Optimization::V1::InjectedSolutionConstraint

Parameter

• value (::Google::Cloud::Optimization::V1::InjectedSolutionConstraint) — Constrain the optimization algorithm to find a final solution that is similar to a previous solution. For example, this may be used to freeze portions of routes which have already been completed or which are to be completed but must not be modified.

  If the injected solution is not feasible, a validation error is not necessarily returned and an error indicating infeasibility may be returned instead.

Returns

• (::Google::Cloud::Optimization::V1::InjectedSolutionConstraint) — Constrain the optimization algorithm to find a final solution that is similar to a previous solution. For example, this may be used to freeze portions of routes which have already been completed or which are to be completed but must not be modified.

  If the injected solution is not feasible, a validation error is not necessarily returned and an error indicating infeasibility may be returned instead.

#interpret_injected_solutions_using_labels

def interpret_injected_solutions_using_labels() -> ::Boolean

Returns

• (::Boolean) — If true:
  • uses ShipmentRoute.vehicle_label instead of vehicle_index to match routes in an injected solution with vehicles in the request; reuses the mapping of original ShipmentRoute.vehicle_index to new ShipmentRoute.vehicle_index to update ConstraintRelaxation.vehicle_indices if non-empty, but the mapping must be unambiguous (i.e., multiple ShipmentRoutes must not share the same original vehicle_index).
  • uses ShipmentRoute.Visit.shipment_label instead of shipment_index to match visits in an injected solution with shipments in the request;
  • uses SkippedShipment.label instead of 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. It can be used when shipment or vehicle indices in the request have changed since the solution was created, perhaps because shipments or 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:

  • Vehicle.label in the request;
  • Shipment.label in the request;
  • ShipmentRoute.vehicle_label in the injected solution;
  • SkippedShipment.label and 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 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 Vehicle.label (resp. 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.

#interpret_injected_solutions_using_labels=

def interpret_injected_solutions_using_labels=(value) -> ::Boolean

Parameter

• value (::Boolean) — If true:
  • uses ShipmentRoute.vehicle_label instead of vehicle_index to match routes in an injected solution with vehicles in the request; reuses the mapping of original ShipmentRoute.vehicle_index to new ShipmentRoute.vehicle_index to update ConstraintRelaxation.vehicle_indices if non-empty, but the mapping must be unambiguous (i.e., multiple ShipmentRoutes must not share the same original vehicle_index).
  • uses ShipmentRoute.Visit.shipment_label instead of shipment_index to match visits in an injected solution with shipments in the request;
  • uses SkippedShipment.label instead of 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. It can be used when shipment or vehicle indices in the request have changed since the solution was created, perhaps because shipments or 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:

  • Vehicle.label in the request;
  • Shipment.label in the request;
  • ShipmentRoute.vehicle_label in the injected solution;
  • SkippedShipment.label and 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 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 Vehicle.label (resp. 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.

Returns

• (::Boolean) — If true:
  • uses ShipmentRoute.vehicle_label instead of vehicle_index to match routes in an injected solution with vehicles in the request; reuses the mapping of original ShipmentRoute.vehicle_index to new ShipmentRoute.vehicle_index to update ConstraintRelaxation.vehicle_indices if non-empty, but the mapping must be unambiguous (i.e., multiple ShipmentRoutes must not share the same original vehicle_index).
  • uses ShipmentRoute.Visit.shipment_label instead of shipment_index to match visits in an injected solution with shipments in the request;
  • uses SkippedShipment.label instead of 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. It can be used when shipment or vehicle indices in the request have changed since the solution was created, perhaps because shipments or 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:

  • Vehicle.label in the request;
  • Shipment.label in the request;
  • ShipmentRoute.vehicle_label in the injected solution;
  • SkippedShipment.label and 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 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 Vehicle.label (resp. 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.

#label

def label() -> ::String

Returns

• (::String) — Label that may be used to identify this request, reported back in the OptimizeToursResponse.request_label.

#label=

def label=(value) -> ::String

Parameter

• value (::String) — Label that may be used to identify this request, reported back in the OptimizeToursResponse.request_label.

Returns

• (::String) — Label that may be used to identify this request, reported back in the OptimizeToursResponse.request_label.

#max_validation_errors

def max_validation_errors() -> ::Integer

Returns

• (::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 OptimizeToursResponse.validation_errors field. This defaults to 100 and is capped at 10,000.

#max_validation_errors=

def max_validation_errors=(value) -> ::Integer

Parameter

• value (::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 OptimizeToursResponse.validation_errors field. This defaults to 100 and is capped at 10,000.

Returns

• (::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 OptimizeToursResponse.validation_errors field. This defaults to 100 and is capped at 10,000.

#model

def model() -> ::Google::Cloud::Optimization::V1::ShipmentModel

Returns

• (::Google::Cloud::Optimization::V1::ShipmentModel) — Shipment model to solve.

#model=

def model=(value) -> ::Google::Cloud::Optimization::V1::ShipmentModel

Parameter

• value (::Google::Cloud::Optimization::V1::ShipmentModel) — Shipment model to solve.

Returns

• (::Google::Cloud::Optimization::V1::ShipmentModel) — Shipment model to solve.

#parent

def parent() -> ::String

Returns

• (::String) — Required. Target project and location to make a call.

  Format: projects/{project-id}/locations/{location-id}.

  If no location is specified, a region will be chosen automatically.

#parent=

def parent=(value) -> ::String

Parameter

• value (::String) — Required. Target project and location to make a call.

  Format: projects/{project-id}/locations/{location-id}.

  If no location is specified, a region will be chosen automatically.

Returns

• (::String) — Required. Target project and location to make a call.

  Format: projects/{project-id}/locations/{location-id}.

  If no location is specified, a region will be chosen automatically.

#populate_polylines

def populate_polylines() -> ::Boolean

Returns

• (::Boolean) — If true, polylines will be populated in response ShipmentRoutes.

#populate_polylines=

def populate_polylines=(value) -> ::Boolean

Parameter

• value (::Boolean) — If true, polylines will be populated in response ShipmentRoutes.

Returns

• (::Boolean) — If true, polylines will be populated in response ShipmentRoutes.

#populate_transition_polylines

def populate_transition_polylines() -> ::Boolean

Returns

• (::Boolean) — If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated travel_steps.

#populate_transition_polylines=

def populate_transition_polylines=(value) -> ::Boolean

Parameter

• value (::Boolean) — If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated travel_steps.

Returns

• (::Boolean) — If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated travel_steps.

#populate_travel_step_polylines

def populate_travel_step_polylines() -> ::Boolean

Returns

• (::Boolean) — Deprecated: Use OptimizeToursRequest.populate_transition_polylines instead. If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated travel_steps.

#populate_travel_step_polylines=

def populate_travel_step_polylines=(value) -> ::Boolean

Parameter

• value (::Boolean) — Deprecated: Use OptimizeToursRequest.populate_transition_polylines instead. If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated travel_steps.

Returns

• (::Boolean) — Deprecated: Use OptimizeToursRequest.populate_transition_polylines instead. If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated travel_steps.

#refresh_details_routes

def refresh_details_routes() -> ::Array<::Google::Cloud::Optimization::V1::ShipmentRoute>

Returns

• (::Array<::Google::Cloud::Optimization::V1::ShipmentRoute>) — If non-empty, the given routes will be refreshed, without modifying their underlying sequence of visits or travel times: only other details will be updated. This does not solve the model.

  As of 2020/11, this only populates the polylines of non-empty routes and requires that populate_polylines is true.

  The route_polyline fields of the passed-in routes may be inconsistent with route transitions.

  This field must not be used together with injected_first_solution_routes or injected_solution_constraint.

  Shipment.ignore and Vehicle.ignore have no effect on the behavior. Polylines are still populated between all visits in all non-empty routes regardless of whether the related shipments or vehicles are ignored.

#refresh_details_routes=

def refresh_details_routes=(value) -> ::Array<::Google::Cloud::Optimization::V1::ShipmentRoute>

Parameter

• value (::Array<::Google::Cloud::Optimization::V1::ShipmentRoute>) — If non-empty, the given routes will be refreshed, without modifying their underlying sequence of visits or travel times: only other details will be updated. This does not solve the model.

  As of 2020/11, this only populates the polylines of non-empty routes and requires that populate_polylines is true.

  The route_polyline fields of the passed-in routes may be inconsistent with route transitions.

  This field must not be used together with injected_first_solution_routes or injected_solution_constraint.

  Shipment.ignore and Vehicle.ignore have no effect on the behavior. Polylines are still populated between all visits in all non-empty routes regardless of whether the related shipments or vehicles are ignored.

Returns

• (::Array<::Google::Cloud::Optimization::V1::ShipmentRoute>) — If non-empty, the given routes will be refreshed, without modifying their underlying sequence of visits or travel times: only other details will be updated. This does not solve the model.

  As of 2020/11, this only populates the polylines of non-empty routes and requires that populate_polylines is true.

  The route_polyline fields of the passed-in routes may be inconsistent with route transitions.

  This field must not be used together with injected_first_solution_routes or injected_solution_constraint.

  Shipment.ignore and Vehicle.ignore have no effect on the behavior. Polylines are still populated between all visits in all non-empty routes regardless of whether the related shipments or vehicles are ignored.

#search_mode

def search_mode() -> ::Google::Cloud::Optimization::V1::OptimizeToursRequest::SearchMode

Returns

• (::Google::Cloud::Optimization::V1::OptimizeToursRequest::SearchMode) — Search mode used to solve the request.

#search_mode=

def search_mode=(value) -> ::Google::Cloud::Optimization::V1::OptimizeToursRequest::SearchMode

Parameter

• value (::Google::Cloud::Optimization::V1::OptimizeToursRequest::SearchMode) — Search mode used to solve the request.

Returns

• (::Google::Cloud::Optimization::V1::OptimizeToursRequest::SearchMode) — Search mode used to solve the request.

#solving_mode

def solving_mode() -> ::Google::Cloud::Optimization::V1::OptimizeToursRequest::SolvingMode

Returns

• (::Google::Cloud::Optimization::V1::OptimizeToursRequest::SolvingMode) — By default, the solving mode is DEFAULT_SOLVE (0).

#solving_mode=

def solving_mode=(value) -> ::Google::Cloud::Optimization::V1::OptimizeToursRequest::SolvingMode

Parameter

• value (::Google::Cloud::Optimization::V1::OptimizeToursRequest::SolvingMode) — By default, the solving mode is DEFAULT_SOLVE (0).

Returns

• (::Google::Cloud::Optimization::V1::OptimizeToursRequest::SolvingMode) — By default, the solving mode is DEFAULT_SOLVE (0).

#timeout

def timeout() -> ::Google::Protobuf::Duration

Returns

• (::Google::Protobuf::Duration) — If this timeout is set, the server returns a response before the timeout period has elapsed or the server deadline for synchronous requests is reached, whichever is sooner.

  For asynchronous requests, the server will generate a solution (if possible) before the timeout has elapsed.

#timeout=

def timeout=(value) -> ::Google::Protobuf::Duration

Parameter

• value (::Google::Protobuf::Duration) — If this timeout is set, the server returns a response before the timeout period has elapsed or the server deadline for synchronous requests is reached, whichever is sooner.

  For asynchronous requests, the server will generate a solution (if possible) before the timeout has elapsed.

Returns

• (::Google::Protobuf::Duration) — If this timeout is set, the server returns a response before the timeout period has elapsed or the server deadline for synchronous requests is reached, whichever is sooner.

  For asynchronous requests, the server will generate a solution (if possible) before the timeout has elapsed.

#use_geodesic_distances

def use_geodesic_distances() -> ::Boolean

Returns

• (::Boolean) — If true, travel distances will be computed using geodesic distances instead of Google Maps distances, and travel times will be computed using geodesic distances with a speed defined by geodesic_meters_per_second.

#use_geodesic_distances=

def use_geodesic_distances=(value) -> ::Boolean

Parameter

• value (::Boolean) — If true, travel distances will be computed using geodesic distances instead of Google Maps distances, and travel times will be computed using geodesic distances with a speed defined by geodesic_meters_per_second.

Returns

• (::Boolean) — If true, travel distances will be computed using geodesic distances instead of Google Maps distances, and travel times will be computed using geodesic distances with a speed defined by geodesic_meters_per_second.