Cloud Optimization v1 API - Class ShipmentRoute (2.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class ShipmentRoute : IMessage<ShipmentRoute>, IEquatable<ShipmentRoute>, IDeepCloneable<ShipmentRoute>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Optimization v1 API class ShipmentRoute.

A vehicle's route can be decomposed, along the time axis, like this (we assume there are n visits):

|            |            |          |       |  T[2], |        |      |
| Transition |  Visit #0  |          |       |  V[2], |        |      |
|     #0     |    aka     |   T[1]   |  V[1] |  ...   | V[n-1] | T[n] |
|  aka T[0]  |    V[0]    |          |       | V[n-2],|        |      |
|            |            |          |       | T[n-1] |        |      |
^            ^            ^          ^       ^        ^        ^      ^
vehicle    V[0].start   V[0].end     V[1].   V[1].    V[n].    V[n]. vehicle
start     (arrival)   (departure)   start   end      start    end     end

Note that we make a difference between:

  • "punctual events", such as the vehicle start and end and each visit's start and end (aka arrival and departure). They happen at a given second.
  • "time intervals", such as the visits themselves, and the transition between visits. Though time intervals can sometimes have zero duration, i.e. start and end at the same second, they often have a positive duration.

Invariants:

  • If there are n visits, there are n+1 transitions.
  • A visit is always surrounded by a transition before it (same index) and a transition after it (index + 1).
  • The vehicle start is always followed by transition #0.
  • The vehicle end is always preceded by transition #n.

Zooming in, here is what happens during a Transition and a Visit:

---+-------------------------------------+-----------------------------+-->
|           TRANSITION[i]             |           VISIT[i]          |
|                                     |                             |
|  * TRAVEL: the vehicle moves from   |      PERFORM the visit:     |
|    VISIT[i-1].departure_location to |                             |
|    VISIT[i].arrival_location, which |  * Spend some time:         |
|    takes a given travel duration    |    the &quot;visit duration&quot;.    |
|    and distance                     |                             |
|                                     |  * Load or unload           |
|  * BREAKS: the driver may have      |    some quantities from the |
|    breaks (e.g. lunch break).       |    vehicle: the &quot;demand&quot;.   |
|                                     |                             |
|  * WAIT: the driver/vehicle does    |                             |
|    nothing. This can happen for     |                             |
|    many reasons, for example when   |                             |
|    the vehicle reaches the next     |                             |
|    event&apos;s destination before the   |                             |
|    start of its time window         |                             |
|                                     |                             |
|  * DELAY: *right before* the next   |                             |
|    arrival. E.g. the vehicle and/or |                             |
|    driver spends time unloading.    |                             |
|                                     |                             |
---+-------------------------------------+-----------------------------+-->
^                                     ^                             ^
V[i-1].end                           V[i].start                    V[i].end

Lastly, here is how the TRAVEL, BREAKS, DELAY and WAIT can be arranged during a transition.

  • They don't overlap.
  • The DELAY is unique and must be a contiguous period of time right before the next visit (or vehicle end). Thus, it suffice to know the delay duration to know its start and end time.
  • The BREAKS are contiguous, non-overlapping periods of time. The response specifies the start time and duration of each break.
  • TRAVEL and WAIT are "preemptable": they can be interrupted several times during this transition. Clients can assume that travel happens "as soon as possible" and that "wait" fills the remaining time.

A (complex) example:

                          TRANSITION[i]
--++-----+-----------------------------------------------------------++-->
||     |       |           |       |           |         |         ||
||  T  |   B   |     T     |       |     B     |         |    D    ||
||  r  |   r   |     r     |   W   |     r     |    W    |    e    ||
||  a  |   e   |     a     |   a   |     e     |    a    |    l    ||
||  v  |   a   |     v     |   i   |     a     |    i    |    a    ||
||  e  |   k   |     e     |   t   |     k     |    t    |    y    ||
||  l  |       |     l     |       |           |         |         ||
||     |       |           |       |           |         |         ||
--++-----------------------------------------------------------------++-->

Inheritance

Object > ShipmentRoute

Namespace

Google.Cloud.Optimization.V1

Assembly

Google.Cloud.Optimization.V1.dll

Constructors

ShipmentRoute()

public ShipmentRoute()

ShipmentRoute(ShipmentRoute)

public ShipmentRoute(ShipmentRoute other)
Parameter
NameDescription
otherShipmentRoute

Properties

Breaks

public RepeatedField<ShipmentRoute.Types.Break> Breaks { get; }

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

Property Value
TypeDescription
RepeatedField<ShipmentRoute.Types.Break>

DelayBeforeVehicleEnd

[Obsolete]
public ShipmentRoute.Types.Delay DelayBeforeVehicleEnd { get; set; }

Deprecated: Use [ShipmentRoute.Transition.delay_duration][] instead. Delay occurring before the vehicle end. See [TransitionAttributes.delay][google.cloud.optimization.v1.TransitionAttributes.delay].

Property Value
TypeDescription
ShipmentRoute.Types.Delay

EndLoads

[Obsolete]
public RepeatedField<CapacityQuantity> EndLoads { get; }

Deprecated: Use [ShipmentRoute.Transition.loads][] instead. Vehicle loads upon arrival at its end location, for each type specified in [Vehicle.capacities][google.cloud.optimization.v1.Vehicle.capacities], start_load_intervals, end_load_intervals or demands. Exception: we omit loads for quantity types unconstrained by intervals and that don't have any non-zero demand on the route.

Property Value
TypeDescription
RepeatedField<CapacityQuantity>

HasTrafficInfeasibilities

public bool HasTrafficInfeasibilities { get; set; }

When [OptimizeToursRequest.consider_road_traffic][google.cloud.optimization.v1.OptimizeToursRequest.consider_road_traffic], is set to true, this field indicates that inconsistencies in route timings are predicted using traffic-based travel duration estimates. There may be insufficient time to complete traffic-adjusted travel, delays, and breaks between visits, before the first visit, or after the last visit, while still satisfying the visit and vehicle time windows. For example,

start_time(previous_visit) + duration(previous_visit) + travel_duration(previous_visit, next_visit) > start_time(next_visit)

Arrival at next_visit will likely happen later than its current time window due the increased estimate of travel time travel_duration(previous_visit, next_visit) due to traffic. Also, a break may be forced to overlap with a visit due to an increase in travel time estimates and visit or break time window restrictions.

Property Value
TypeDescription
Boolean

Metrics

public AggregatedMetrics Metrics { get; set; }

Duration, distance and load metrics for this route. The fields of [AggregatedMetrics][google.cloud.optimization.v1.AggregatedMetrics] are summed over all [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions] or [ShipmentRoute.visits][google.cloud.optimization.v1.ShipmentRoute.visits], depending on the context.

Property Value
TypeDescription
AggregatedMetrics

RouteCosts

public MapField<string, double> RouteCosts { get; }

Cost of the route, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole route. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the route. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.

Property Value
TypeDescription
MapField<String, Double>

RoutePolyline

public ShipmentRoute.Types.EncodedPolyline RoutePolyline { get; set; }

The encoded polyline representation of the route. This field is only populated if [OptimizeToursRequest.populate_polylines][google.cloud.optimization.v1.OptimizeToursRequest.populate_polylines] is set to true.

Property Value
TypeDescription
ShipmentRoute.Types.EncodedPolyline

RouteTotalCost

public double RouteTotalCost { get; set; }

Total cost of the route. The sum of all costs in the cost map.

Property Value
TypeDescription
Double

Transitions

public RepeatedField<ShipmentRoute.Types.Transition> Transitions { get; }

Ordered list of transitions for the route.

Property Value
TypeDescription
RepeatedField<ShipmentRoute.Types.Transition>

TravelSteps

[Obsolete]
public RepeatedField<ShipmentRoute.Types.TravelStep> TravelSteps { get; }

Deprecated: Use [ShipmentRoute.Transition][] instead. Ordered list of travel steps for the route.

Property Value
TypeDescription
RepeatedField<ShipmentRoute.Types.TravelStep>

VehicleDetour

[Obsolete]
public Duration VehicleDetour { get; set; }

Deprecated: No longer used. This field will only be populated at the [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit] level. Extra detour time due to the shipments visited on the route.

It is equal to vehicle_end_time - vehicle_start_time - travel duration from the vehicle's start_location to its end_location.

Property Value
TypeDescription
Duration

VehicleEndTime

public Timestamp VehicleEndTime { get; set; }

Time at which the vehicle finishes its route.

Property Value
TypeDescription
Timestamp

VehicleIndex

public int VehicleIndex { get; set; }

Vehicle performing the route, identified by its index in the source ShipmentModel.

Property Value
TypeDescription
Int32

VehicleLabel

public string VehicleLabel { get; set; }

Label of the vehicle performing this route, equal to ShipmentModel.vehicles(vehicle_index).label, if specified.

Property Value
TypeDescription
String

VehicleStartTime

public Timestamp VehicleStartTime { get; set; }

Time at which the vehicle starts its route.

Property Value
TypeDescription
Timestamp

Visits

public RepeatedField<ShipmentRoute.Types.Visit> Visits { get; }

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

Property Value
TypeDescription
RepeatedField<ShipmentRoute.Types.Visit>