Class OptimizeToursRequest

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

Inheritance
object
OptimizeToursRequest
Implements
Inherited Members
Namespace: Google.Maps.RouteOptimization.V1
Assembly: Google.Maps.RouteOptimization.V1.dll
Syntax
public sealed class OptimizeToursRequest : IMessage<OptimizeToursRequest>, IEquatable<OptimizeToursRequest>, IDeepCloneable<OptimizeToursRequest>, IBufferMessage, IMessage

Constructors

OptimizeToursRequest()

Declaration
public OptimizeToursRequest()

OptimizeToursRequest(OptimizeToursRequest)

Declaration
public OptimizeToursRequest(OptimizeToursRequest other)
Parameters
Type Name Description
OptimizeToursRequest other

Properties

AllowLargeDeadlineDespiteInterruptionRisk

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.

Declaration
public bool AllowLargeDeadlineDespiteInterruptionRisk { get; set; }
Property Value
Type Description
bool

ConsiderRoadTraffic

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.

Declaration
public bool ConsiderRoadTraffic { get; set; }
Property Value
Type Description
bool

GeodesicMetersPerSecond

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.

Declaration
public double GeodesicMetersPerSecond { get; set; }
Property Value
Type Description
double

HasGeodesicMetersPerSecond

Gets whether the "geodesic_meters_per_second" field is set

Declaration
public bool HasGeodesicMetersPerSecond { get; }
Property Value
Type Description
bool

HasMaxValidationErrors

Gets whether the "max_validation_errors" field is set

Declaration
public bool HasMaxValidationErrors { get; }
Property Value
Type Description
bool

InjectedFirstSolutionRoutes

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.

Declaration
public RepeatedField<ShipmentRoute> InjectedFirstSolutionRoutes { get; }
Property Value
Type Description
RepeatedField<ShipmentRoute>

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.

Declaration
public InjectedSolutionConstraint InjectedSolutionConstraint { get; set; }
Property Value
Type Description
InjectedSolutionConstraint

InterpretInjectedSolutionsUsingLabels

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.

Declaration
public bool InterpretInjectedSolutionsUsingLabels { get; set; }
Property Value
Type Description
bool

Label

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

Declaration
public string Label { get; set; }
Property Value
Type Description
string

MaxValidationErrors

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.

Declaration
public int MaxValidationErrors { get; set; }
Property Value
Type Description
int

Model

Shipment model to solve.

Declaration
public ShipmentModel Model { get; set; }
Property Value
Type Description
ShipmentModel

Parent

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.

Declaration
public string Parent { get; set; }
Property Value
Type Description
string

PopulatePolylines

If true, polylines will be populated in response ShipmentRoutes.

Declaration
public bool PopulatePolylines { get; set; }
Property Value
Type Description
bool

PopulateTransitionPolylines

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

Declaration
public bool PopulateTransitionPolylines { get; set; }
Property Value
Type Description
bool

RefreshDetailsRoutes

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.

Declaration
public RepeatedField<ShipmentRoute> RefreshDetailsRoutes { get; }
Property Value
Type Description
RepeatedField<ShipmentRoute>

SearchMode

Search mode used to solve the request.

Declaration
public OptimizeToursRequest.Types.SearchMode SearchMode { get; set; }
Property Value
Type Description
OptimizeToursRequest.Types.SearchMode

SolvingMode

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

Declaration
public OptimizeToursRequest.Types.SolvingMode SolvingMode { get; set; }
Property Value
Type Description
OptimizeToursRequest.Types.SolvingMode

Timeout

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.

Declaration
public Duration Timeout { get; set; }
Property Value
Type Description
Duration

UseGeodesicDistances

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.

Declaration
public bool UseGeodesicDistances { get; set; }
Property Value
Type Description
bool