Reference documentation and code samples for the Google Maps Route Optimization V1 Client class Transition.
Transition between two events on the route. See the description of ShipmentRoute .
If the vehicle does not have a start_location
and/or end_location
, the
corresponding travel metrics are 0.
Generated from protobuf message google.maps.routeoptimization.v1.ShipmentRoute.Transition
Namespace
Google \ Maps \ RouteOptimization \ V1 \ ShipmentRouteMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ travel_duration
↳ travel_distance_meters
float
Distance traveled during the transition.
↳ traffic_info_unavailable
bool
When traffic is requested via [OptimizeToursRequest.consider_road_traffic] [google.maps.routeoptimization.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).
↳ delay_duration
Google\Protobuf\Duration
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
.
↳ break_duration
Google\Protobuf\Duration
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 .
↳ wait_duration
Google\Protobuf\Duration
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.
↳ total_duration
Google\Protobuf\Duration
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
.
↳ start_time
↳ route_polyline
EncodedPolyline
The encoded polyline representation of the route followed during the transition. This field is only populated if [populate_transition_polylines] [google.maps.routeoptimization.v1.OptimizeToursRequest.populate_transition_polylines] is set to true.
↳ route_token
string
Output only. An opaque token that can be passed to Navigation SDK to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when the route was created. Treat this token as an opaque blob. Don't compare its value across requests as its value may change even if the service returns the exact same route. This field is only populated if [populate_transition_polylines] [google.maps.routeoptimization.v1.OptimizeToursRequest.populate_transition_polylines] is set to true.
↳ vehicle_loads
array| Google\Protobuf\Internal\MapField
Vehicle loads during this transition, for each type that either appears in this vehicle's Vehicle.load_limits
, or that have non-zero 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.
getTravelDuration
Travel duration during this transition.
hasTravelDuration
clearTravelDuration
setTravelDuration
Travel duration during this transition.
$this
getTravelDistanceMeters
Distance traveled during the transition.
float
setTravelDistanceMeters
Distance traveled during the transition.
var
float
$this
getTrafficInfoUnavailable
When traffic is requested via 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).
bool
setTrafficInfoUnavailable
When traffic is requested via 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).
var
bool
$this
getDelayDuration
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
.
hasDelayDuration
clearDelayDuration
setDelayDuration
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
.
$this
getBreakDuration
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 .
hasBreakDuration
clearBreakDuration
setBreakDuration
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 .
$this
getWaitDuration
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.
hasWaitDuration
clearWaitDuration
setWaitDuration
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.
$this
getTotalDuration
Total duration of the transition, provided for convenience. It is equal to:
- next visit
start_time(orvehicle_end_timeif this is the last transition) - this transition'sstart_time; - if
ShipmentRoute.has_traffic_infeasibilitiesis false, the following additionally holds: `total_duration = travel_duration + delay_duration - break_duration + wait_duration`.
hasTotalDuration
clearTotalDuration
setTotalDuration
Total duration of the transition, provided for convenience. It is equal to:
- next visit
start_time(orvehicle_end_timeif this is the last transition) - this transition'sstart_time; - if
ShipmentRoute.has_traffic_infeasibilitiesis false, the following additionally holds: `total_duration = travel_duration + delay_duration - break_duration + wait_duration`.
$this
getStartTime
Start time of this transition.
hasStartTime
clearStartTime
setStartTime
Start time of this transition.
$this
getRoutePolyline
The encoded polyline representation of the route followed during the transition.
This field is only populated if populate_transition_polylines is set to true.
hasRoutePolyline
clearRoutePolyline
setRoutePolyline
The encoded polyline representation of the route followed during the transition.
This field is only populated if populate_transition_polylines is set to true.
$this
getRouteToken
Output only. An opaque token that can be passed to Navigation SDK to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when the route was created. Treat this token as an opaque blob. Don't compare its value across requests as its value may change even if the service returns the exact same route. This field is only populated if populate_transition_polylines is set to true.
string
setRouteToken
Output only. An opaque token that can be passed to Navigation SDK to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when the route was created. Treat this token as an opaque blob. Don't compare its value across requests as its value may change even if the service returns the exact same route. This field is only populated if populate_transition_polylines is set to true.
var
string
$this
getVehicleLoads
Vehicle loads during this transition, for each type that either appears in this vehicle's Vehicle.load_limits , or that have non-zero 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.
setVehicleLoads
Vehicle loads during this transition, for each type that either appears in this vehicle's Vehicle.load_limits , or that have non-zero 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.
$this
