Cloud Optimization V1 API - Class Google::Cloud::Optimization::V1::ShipmentRoute::TravelStep (v0.9.2)

Reference documentation and code samples for the Cloud Optimization V1 API class Google::Cloud::Optimization::V1::ShipmentRoute::TravelStep.

Deprecated: Use ShipmentRoute.Transition 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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#distance_meters

def distance_meters() -> ::Float

Returns

(::Float) — Distance traveled during the step.

#distance_meters=

def distance_meters=(value) -> ::Float

Parameter

value (::Float) — Distance traveled during the step.

Returns

(::Float) — Distance traveled during the step.

#duration

def duration() -> ::Google::Protobuf::Duration

Returns

(::Google::Protobuf::Duration) — Duration of the travel step.

#duration=

def duration=(value) -> ::Google::Protobuf::Duration

Parameter

value (::Google::Protobuf::Duration) — Duration of the travel step.

Returns

(::Google::Protobuf::Duration) — Duration of the travel step.

#route_polyline

def route_polyline() -> ::Google::Cloud::Optimization::V1::ShipmentRoute::EncodedPolyline

Returns

(::Google::Cloud::Optimization::V1::ShipmentRoute::EncodedPolyline) — The encoded polyline representation of the route followed during the step.

This field is only populated if OptimizeToursRequest.populate_travel_step_polylines is set to true.

#route_polyline=

def route_polyline=(value) -> ::Google::Cloud::Optimization::V1::ShipmentRoute::EncodedPolyline

Parameter

value (::Google::Cloud::Optimization::V1::ShipmentRoute::EncodedPolyline) — The encoded polyline representation of the route followed during the step.

This field is only populated if OptimizeToursRequest.populate_travel_step_polylines is set to true.

Returns

(::Google::Cloud::Optimization::V1::ShipmentRoute::EncodedPolyline) — The encoded polyline representation of the route followed during the step.

This field is only populated if OptimizeToursRequest.populate_travel_step_polylines is set to true.

#traffic_info_unavailable

def traffic_info_unavailable() -> ::Boolean

Returns

(::Boolean) — When traffic is requested via 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).

#traffic_info_unavailable=

def traffic_info_unavailable=(value) -> ::Boolean

Parameter

value (::Boolean) — When traffic is requested via 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).

Returns

(::Boolean) — When traffic is requested via 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).