Cloud Optimization v1 API - Class ShipmentRoute.Types.TravelStep (2.1.0) 

[Obsolete]
public sealed class TravelStep : IMessage<ShipmentRoute.Types.TravelStep>, IEquatable<ShipmentRoute.Types.TravelStep>, IDeepCloneable<ShipmentRoute.Types.TravelStep>, IBufferMessage, IMessage

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

Deprecated: Use [ShipmentRoute.transitions][] instead. Travel between each visit, along the route: from the vehicle's start_location to the first visit's arrival_location, then from the first visit's departure_location to the second visit's arrival_location, and so on until the vehicle's end_location. This accounts only for the actual travel between visits, not counting the waiting time, the time spent performing a visit, nor the distance covered during a visit.

Invariant: travel_steps_size() == visits_size() + 1.

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

Inheritance

Object > ShipmentRoute.Types.TravelStep

Namespace

Google.Cloud.Optimization.V1

Assembly

Google.Cloud.Optimization.V1.dll

Constructors

TravelStep()

public TravelStep()

TravelStep(ShipmentRoute.Types.TravelStep)

public TravelStep(ShipmentRoute.Types.TravelStep other)
Parameter
Name Description
other ShipmentRoute.Types.TravelStep

Properties

DistanceMeters

public double DistanceMeters { get; set; }

Distance traveled during the step.

Property Value
Type Description
Double

Duration

public Duration Duration { get; set; }

Duration of the travel step.

Property Value
Type Description
Duration

RoutePolyline

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

The encoded polyline representation of the route followed during the step.

This field is only populated if [OptimizeToursRequest.populate_travel_step_polylines][google.cloud.optimization.v1.OptimizeToursRequest.populate_travel_step_polylines] is set to true.

Property Value
Type Description
ShipmentRoute.Types.EncodedPolyline

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 TravelStep, 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
Type Description
Boolean