Cloud Optimization v1 API - Class ShipmentRoute.Types.Transition (2.0.0)

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

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

Transition between two events on the route. See the description of [ShipmentRoute][google.cloud.optimization.v1.ShipmentRoute].

If the vehicle does not have a start_location and/or end_location, the corresponding travel metrics are 0.

Inheritance

Object > ShipmentRoute.Types.Transition

Namespace

Google.Cloud.Optimization.V1

Assembly

Google.Cloud.Optimization.V1.dll

Constructors

Transition()

public Transition()

Transition(ShipmentRoute.Types.Transition)

public Transition(ShipmentRoute.Types.Transition other)
Parameter
NameDescription
otherShipmentRoute.Types.Transition

Properties

BreakDuration

public Duration BreakDuration { get; set; }

Sum of the duration of the breaks occurring during this transition, if any. Details about each break's start time and duration are stored in [ShipmentRoute.breaks][google.cloud.optimization.v1.ShipmentRoute.breaks].

Property Value
TypeDescription
Duration

DelayDuration

public Duration DelayDuration { get; set; }

Sum of the delay durations applied to this transition. If any, the delay starts exactly delay_duration seconds before the next event (visit or vehicle end). See [TransitionAttributes.delay][google.cloud.optimization.v1.TransitionAttributes.delay].

Property Value
TypeDescription
Duration

Loads

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

Deprecated: Use [Transition.vehicle_loads][] instead.

Property Value
TypeDescription
RepeatedField<CapacityQuantity>

RoutePolyline

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

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

Property Value
TypeDescription
ShipmentRoute.Types.EncodedPolyline

StartTime

public Timestamp StartTime { get; set; }

Start time of this transition.

Property Value
TypeDescription
Timestamp

TotalDuration

public Duration TotalDuration { get; set; }

Total duration of the transition, provided for convenience. It is equal to:

  • next visit start_time (or vehicle_end_time if this is the last transition) - this transition's start_time;
  • if ShipmentRoute.has_traffic_infeasibilities is false, the following additionally holds: `total_duration = travel_duration + delay_duration
  • break_duration + wait_duration`.
Property Value
TypeDescription
Duration

TrafficInfoUnavailable

public bool TrafficInfoUnavailable { get; set; }

When traffic is requested via [OptimizeToursRequest.consider_road_traffic] [google.cloud.optimization.v1.OptimizeToursRequest.consider_road_traffic], and the traffic info couldn't be retrieved for a Transition, this boolean is set to true. This may be temporary (rare hiccup in the realtime traffic servers) or permanent (no data for this location).

Property Value
TypeDescription
Boolean

TravelDistanceMeters

public double TravelDistanceMeters { get; set; }

Distance traveled during the transition.

Property Value
TypeDescription
Double

TravelDuration

public Duration TravelDuration { get; set; }

Travel duration during this transition.

Property Value
TypeDescription
Duration

VehicleLoads

public MapField<string, ShipmentRoute.Types.VehicleLoad> VehicleLoads { get; }

Vehicle loads during this transition, for each type that either appears in this vehicle's [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits], or that have non-zero [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] on some shipment performed on this route.

The loads during the first transition are the starting loads of the vehicle route. Then, after each visit, the visit's load_demands are either added or subtracted to get the next transition's loads, depending on whether the visit was a pickup or a delivery.

Property Value
TypeDescription
MapField<String, ShipmentRoute.Types.VehicleLoad>

WaitDuration

public Duration WaitDuration { get; set; }

Time spent waiting during this transition. Wait duration corresponds to idle time and does not include break time. Also note that this wait time may be split into several non-contiguous intervals.

Property Value
TypeDescription
Duration