Cloud Optimization V1 API - Class Google::Cloud::Optimization::V1::ShipmentRoute::Transition (v0.10.0)

Reference documentation and code samples for the Cloud Optimization V1 API class Google::Cloud::Optimization::V1::ShipmentRoute::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#break_duration

def break_duration() -> ::Google::Protobuf::Duration
Returns

#break_duration=

def break_duration=(value) -> ::Google::Protobuf::Duration
Parameter
Returns

#delay_duration

def delay_duration() -> ::Google::Protobuf::Duration
Returns

#delay_duration=

def delay_duration=(value) -> ::Google::Protobuf::Duration
Parameter
Returns

#loads

def loads() -> ::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>
Returns

#loads=

def loads=(value) -> ::Array<::Google::Cloud::Optimization::V1::CapacityQuantity>
Parameter
Returns

#route_polyline

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

#route_polyline=

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

#start_time

def start_time() -> ::Google::Protobuf::Timestamp
Returns

#start_time=

def start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#total_duration

def total_duration() -> ::Google::Protobuf::Duration
Returns
  • (::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`.

#total_duration=

def total_duration=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::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`.
Returns
  • (::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`.

#traffic_info_unavailable

def traffic_info_unavailable() -> ::Boolean
Returns
  • (::Boolean) — 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).

#traffic_info_unavailable=

def traffic_info_unavailable=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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).
Returns
  • (::Boolean) — 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).

#travel_distance_meters

def travel_distance_meters() -> ::Float
Returns
  • (::Float) — Distance traveled during the transition.

#travel_distance_meters=

def travel_distance_meters=(value) -> ::Float
Parameter
  • value (::Float) — Distance traveled during the transition.
Returns
  • (::Float) — Distance traveled during the transition.

#travel_duration

def travel_duration() -> ::Google::Protobuf::Duration
Returns

#travel_duration=

def travel_duration=(value) -> ::Google::Protobuf::Duration
Parameter
Returns

#vehicle_loads

def vehicle_loads() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::ShipmentRoute::VehicleLoad}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::ShipmentRoute::VehicleLoad}) — 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.

#vehicle_loads=

def vehicle_loads=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::ShipmentRoute::VehicleLoad}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::ShipmentRoute::VehicleLoad}) — 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.

Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::ShipmentRoute::VehicleLoad}) — 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.

#wait_duration

def wait_duration() -> ::Google::Protobuf::Duration
Returns
  • (::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.

#wait_duration=

def wait_duration=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::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.
Returns
  • (::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.