Class: Google::Cloud::Optimization::V1::OptimizeToursResponse::Metrics

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/optimization/v1/fleet_routing.rb

Overview

Overall metrics, aggregated over all routes.

Defined Under Namespace

Classes: CostsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#aggregated_route_metrics ⇒ ::Google::Cloud::Optimization::V1::AggregatedMetrics

Returns Aggregated over the routes. Each metric is the sum (or max, for loads) over all ShipmentRoute.metrics fields of the same name.

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 359

class Metrics
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Float]
  class CostsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#costs ⇒ ::Google::Protobuf::Map{::String => ::Float}

Returns 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.



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 359

class Metrics
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Float]
  class CostsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#earliest_vehicle_start_time ⇒ ::Google::Protobuf::Timestamp

Returns The earliest start time for a used vehicle, computed as the minimum over all used vehicles of ShipmentRoute.vehicle_start_time.

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 359

class Metrics
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Float]
  class CostsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#latest_vehicle_end_time ⇒ ::Google::Protobuf::Timestamp

Returns The latest end time for a used vehicle, computed as the maximum over all used vehicles of ShipmentRoute.vehicle_end_time.

Returns:



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 359

class Metrics
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Float]
  class CostsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#skipped_mandatory_shipment_count ⇒ ::Integer

Returns Number of mandatory shipments skipped.

Returns:

  • (::Integer) —

    Number of mandatory shipments skipped.



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 359

class Metrics
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Float]
  class CostsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#total_cost ⇒ ::Float

Returns 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.



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 359

class Metrics
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Float]
  class CostsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#used_vehicle_count ⇒ ::Integer

Returns 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.



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 359

class Metrics
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Float]
  class CostsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end