Cloud Optimization V1 API - Class Google::Cloud::Optimization::V1::OptimizeToursResponse::Metrics (v0.5.0)

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

Overall metrics, aggregated over all routes.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#aggregated_route_metrics

def aggregated_route_metrics() -> ::Google::Cloud::Optimization::V1::AggregatedMetrics
Returns

#aggregated_route_metrics=

def aggregated_route_metrics=(value) -> ::Google::Cloud::Optimization::V1::AggregatedMetrics
Parameter
Returns

#costs

def costs() -> ::Google::Protobuf::Map{::String => ::Float}
Returns
  • (::Google::Protobuf::Map{::String => ::Float}) — Cost of the solution, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole solution. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the solution. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.

#costs=

def costs=(value) -> ::Google::Protobuf::Map{::String => ::Float}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Float}) — Cost of the solution, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole solution. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the solution. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.
Returns
  • (::Google::Protobuf::Map{::String => ::Float}) — Cost of the solution, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole solution. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the solution. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.

#earliest_vehicle_start_time

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

#earliest_vehicle_start_time=

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

#latest_vehicle_end_time

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

#latest_vehicle_end_time=

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

#skipped_mandatory_shipment_count

def skipped_mandatory_shipment_count() -> ::Integer
Returns
  • (::Integer) — Number of mandatory shipments skipped.

#skipped_mandatory_shipment_count=

def skipped_mandatory_shipment_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Number of mandatory shipments skipped.
Returns
  • (::Integer) — Number of mandatory shipments skipped.

#total_cost

def total_cost() -> ::Float
Returns
  • (::Float) — Total cost of the solution. The sum of all values in the costs map.

#total_cost=

def total_cost=(value) -> ::Float
Parameter
  • value (::Float) — Total cost of the solution. The sum of all values in the costs map.
Returns
  • (::Float) — Total cost of the solution. The sum of all values in the costs map.

#used_vehicle_count

def used_vehicle_count() -> ::Integer
Returns
  • (::Integer) — Number of vehicles used. Note: if a vehicle route is empty and Vehicle.used_if_route_is_empty is true, the vehicle is considered used.

#used_vehicle_count=

def used_vehicle_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Number of vehicles used. Note: if a vehicle route is empty and Vehicle.used_if_route_is_empty is true, the vehicle is considered used.
Returns
  • (::Integer) — Number of vehicles used. Note: if a vehicle route is empty and Vehicle.used_if_route_is_empty is true, the vehicle is considered used.