Struct google_api_proto::google::maps::routeoptimization::v1::OptimizeToursRequest

pub struct OptimizeToursRequest {

    pub parent: String,
    pub timeout: Option<Duration>,
    pub model: Option<ShipmentModel>,
    pub solving_mode: i32,
    pub search_mode: i32,
    pub injected_first_solution_routes: Vec<ShipmentRoute>,
    pub injected_solution_constraint: Option<InjectedSolutionConstraint>,
    pub refresh_details_routes: Vec<ShipmentRoute>,
    pub interpret_injected_solutions_using_labels: bool,
    pub consider_road_traffic: bool,
    pub populate_polylines: bool,
    pub populate_transition_polylines: bool,
    pub allow_large_deadline_despite_interruption_risk: bool,
    pub use_geodesic_distances: bool,
    pub geodesic_meters_per_second: Option<f64>,
    pub max_validation_errors: Option<i32>,
    pub label: String,
}

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

Fields

parent: String

Required. Target project or location to make a call.

Format:

• projects/{project-id}
• projects/{project-id}/locations/{location-id}

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

timeout: Option<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.

model: Option<ShipmentModel>

Shipment model to solve.

solving_mode: i32

By default, the solving mode is DEFAULT_SOLVE (0).

search_mode: i32

Search mode used to solve the request.

injected_first_solution_routes: Vec<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][google.maps.routeoptimization.v1.Shipment.allowed_vehicle_indices] is empty or its vehicle_index is included in [Shipment.allowed_vehicle_indices][google.maps.routeoptimization.v1.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: Option<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.

refresh_details_routes: Vec<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.

interpret_injected_solutions_using_labels: bool

If true:

• uses [ShipmentRoute.vehicle_label][google.maps.routeoptimization.v1.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][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_index] to new [ShipmentRoute.vehicle_index][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_index] to update [ConstraintRelaxation.vehicle_indices][google.maps.routeoptimization.v1.InjectedSolutionConstraint.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][google.maps.routeoptimization.v1.ShipmentRoute.Visit.shipment_label] instead of shipment_index to match visits in an injected solution with shipments in the request;
• uses [SkippedShipment.label][google.maps.routeoptimization.v1.SkippedShipment.label] instead of [SkippedShipment.index][google.maps.routeoptimization.v1.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][google.maps.routeoptimization.v1.Vehicle.label] in the request;
• [Shipment.label][google.maps.routeoptimization.v1.Shipment.label] in the request;
• [ShipmentRoute.vehicle_label][google.maps.routeoptimization.v1.ShipmentRoute.vehicle_label] in the injected solution;
• [SkippedShipment.label][google.maps.routeoptimization.v1.SkippedShipment.label] and [ShipmentRoute.Visit.shipment_label][google.maps.routeoptimization.v1.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][google.maps.routeoptimization.v1.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][google.maps.routeoptimization.v1.Vehicle.label] (resp. [Shipment.label][google.maps.routeoptimization.v1.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.

consider_road_traffic: bool

Consider traffic estimation in calculating ShipmentRoute fields [Transition.travel_duration][google.maps.routeoptimization.v1.ShipmentRoute.Transition.travel_duration], [Visit.start_time][google.maps.routeoptimization.v1.ShipmentRoute.Visit.start_time], and vehicle_end_time; in setting the [ShipmentRoute.has_traffic_infeasibilities][google.maps.routeoptimization.v1.ShipmentRoute.has_traffic_infeasibilities] field, and in calculating the [OptimizeToursResponse.total_cost][google.maps.routeoptimization.v1.OptimizeToursResponse.total_cost] field.

populate_polylines: bool

If true, polylines will be populated in response ShipmentRoutes.

populate_transition_polylines: bool

If true, polylines will be populated in response [ShipmentRoute.transitions][google.maps.routeoptimization.v1.ShipmentRoute.transitions].

allow_large_deadline_despite_interruption_risk: bool

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.

use_geodesic_distances: bool

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.

geodesic_meters_per_second: Option<f64>

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.

max_validation_errors: Option<i32>

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][google.maps.routeoptimization.v1.OptimizeToursResponse.validation_errors] field. This defaults to 100 and is capped at 10,000.

label: String

Label that may be used to identify this request, reported back in the [OptimizeToursResponse.request_label][google.maps.routeoptimization.v1.OptimizeToursResponse.request_label].

Implementations

impl OptimizeToursRequest

pub fn solving_mode(&self) -> SolvingMode

Returns the enum value of solving_mode, or the default if the field is set to an invalid enum value.

pub fn set_solving_mode(&mut self, value: SolvingMode)

Sets solving_mode to the provided enum value.

pub fn max_validation_errors(&self) -> i32

Returns the value of max_validation_errors, or the default value if max_validation_errors is unset.

pub fn search_mode(&self) -> SearchMode

Returns the enum value of search_mode, or the default if the field is set to an invalid enum value.

pub fn set_search_mode(&mut self, value: SearchMode)

Sets search_mode to the provided enum value.

pub fn geodesic_meters_per_second(&self) -> f64

Returns the value of geodesic_meters_per_second, or the default value if geodesic_meters_per_second is unset.

Trait Implementations

impl Clone for OptimizeToursRequest

fn clone(&self) -> OptimizeToursRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OptimizeToursRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OptimizeToursRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for OptimizeToursRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for OptimizeToursRequest

fn eq(&self, other: &OptimizeToursRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OptimizeToursRequest