Cloud Optimization V1 API - Class Google::Cloud::Optimization::V1::AggregatedMetrics (v0.2.1)

Version 0.2.1

• 0.10.0 (latest)
• 0.9.2
• 0.8.2
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.1
• 0.1.1

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

Aggregated metrics for ShipmentRoute (resp. for OptimizeToursResponse over all Transition and/or Visit (resp. over all ShipmentRoute) elements.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#break_duration

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

Returns

• (::Google::Protobuf::Duration) — Total break duration for a route or a solution.

#break_duration=

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

Parameter

• value (::Google::Protobuf::Duration) — Total break duration for a route or a solution.

Returns

• (::Google::Protobuf::Duration) — Total break duration for a route or a solution.

#costs

def costs() -> ::Google::Protobuf::Map{::String => ::Float}

Returns

• (::Google::Protobuf::Map{::String => ::Float}) — Deprecated: Use ShipmentRoute.route_costs and OptimizeToursResponse.Metrics.costs instead.

#costs=

def costs=(value) -> ::Google::Protobuf::Map{::String => ::Float}

Parameter

• value (::Google::Protobuf::Map{::String => ::Float}) — Deprecated: Use ShipmentRoute.route_costs and OptimizeToursResponse.Metrics.costs instead.

Returns

• (::Google::Protobuf::Map{::String => ::Float}) — Deprecated: Use ShipmentRoute.route_costs and OptimizeToursResponse.Metrics.costs instead.

#delay_duration

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

Returns

• (::Google::Protobuf::Duration) — Total delay duration for a route or a solution.

#delay_duration=

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

Parameter

• value (::Google::Protobuf::Duration) — Total delay duration for a route or a solution.

Returns

• (::Google::Protobuf::Duration) — Total delay duration for a route or a solution.

#max_loads

def max_loads() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::ShipmentRoute::VehicleLoad}

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::ShipmentRoute::VehicleLoad}) — Maximum load achieved over the entire route (resp. solution), for each of the quantities on this route (resp. solution), computed as the maximum over all Transition.vehicle_loads (resp. ShipmentRoute.metrics.max_loads.

#max_loads=

def max_loads=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::ShipmentRoute::VehicleLoad}

Parameter

• value (::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::ShipmentRoute::VehicleLoad}) — Maximum load achieved over the entire route (resp. solution), for each of the quantities on this route (resp. solution), computed as the maximum over all Transition.vehicle_loads (resp. ShipmentRoute.metrics.max_loads.

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::Optimization::V1::ShipmentRoute::VehicleLoad}) — Maximum load achieved over the entire route (resp. solution), for each of the quantities on this route (resp. solution), computed as the maximum over all Transition.vehicle_loads (resp. ShipmentRoute.metrics.max_loads.

#performed_shipment_count

def performed_shipment_count() -> ::Integer

Returns

• (::Integer) — Number of shipments performed. Note that a pickup and delivery pair only counts once.

#performed_shipment_count=

def performed_shipment_count=(value) -> ::Integer

Parameter

• value (::Integer) — Number of shipments performed. Note that a pickup and delivery pair only counts once.

Returns

• (::Integer) — Number of shipments performed. Note that a pickup and delivery pair only counts once.

#total_cost

def total_cost() -> ::Float

Returns

• (::Float) — Deprecated: Use ShipmentRoute.route_total_cost and OptimizeToursResponse.Metrics.total_cost instead.

#total_cost=

def total_cost=(value) -> ::Float

Parameter

• value (::Float) — Deprecated: Use ShipmentRoute.route_total_cost and OptimizeToursResponse.Metrics.total_cost instead.

Returns

• (::Float) — Deprecated: Use ShipmentRoute.route_total_cost and OptimizeToursResponse.Metrics.total_cost instead.

#total_duration

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

Returns

• (::Google::Protobuf::Duration) — The total duration should be equal to the sum of all durations above. For routes, it also corresponds to

  ShipmentRoute.vehicle_end_time

  ShipmentRoute.vehicle_start_time.

#total_duration=

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

Parameter

• value (::Google::Protobuf::Duration) — The total duration should be equal to the sum of all durations above. For routes, it also corresponds to

  ShipmentRoute.vehicle_end_time

  ShipmentRoute.vehicle_start_time.

Returns

• (::Google::Protobuf::Duration) — The total duration should be equal to the sum of all durations above. For routes, it also corresponds to

  ShipmentRoute.vehicle_end_time

  ShipmentRoute.vehicle_start_time.

#travel_distance_meters

def travel_distance_meters() -> ::Float

Returns

• (::Float) — Total travel distance for a route or a solution.

#travel_distance_meters=

def travel_distance_meters=(value) -> ::Float

Parameter

• value (::Float) — Total travel distance for a route or a solution.

Returns

• (::Float) — Total travel distance for a route or a solution.

#travel_duration

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

Returns

• (::Google::Protobuf::Duration) — Total travel duration for a route or a solution.

#travel_duration=

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

Parameter

• value (::Google::Protobuf::Duration) — Total travel duration for a route or a solution.

Returns

• (::Google::Protobuf::Duration) — Total travel duration for a route or a solution.

#visit_duration

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

Returns

• (::Google::Protobuf::Duration) — Total visit duration for a route or a solution.

#visit_duration=

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

Parameter

• value (::Google::Protobuf::Duration) — Total visit duration for a route or a solution.

Returns

• (::Google::Protobuf::Duration) — Total visit duration for a route or a solution.

#wait_duration

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

Returns

• (::Google::Protobuf::Duration) — Total wait duration for a route or a solution.

#wait_duration=

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

Parameter

• value (::Google::Protobuf::Duration) — Total wait duration for a route or a solution.

Returns

• (::Google::Protobuf::Duration) — Total wait duration for a route or a solution.