Class Metrics (1.8.2)

Version latest

• 1.8.3 (latest)
• 1.8.2
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.3
• 1.3.2
• 1.2.0
• 1.1.3
• 1.0.1
• 0.1.1

Metrics(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Overall metrics, aggregated over all routes.

Attributes
Name	Description
aggregated_route_metrics	google.cloud.optimization_v1.types.AggregatedMetrics Aggregated over the routes. Each metric is the sum (or max, for loads) over all ShipmentRoute.metrics fields of the same name.
skipped_mandatory_shipment_count	int Number of mandatory shipments skipped.
used_vehicle_count	int 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.
earliest_vehicle_start_time	google.protobuf.timestamp_pb2.Timestamp The earliest start time for a used vehicle, computed as the minimum over all used vehicles of ShipmentRoute.vehicle_start_time.
latest_vehicle_end_time	google.protobuf.timestamp_pb2.Timestamp The latest end time for a used vehicle, computed as the maximum over all used vehicles of ShipmentRoute.vehicle_end_time.
costs	MutableMapping[str, 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.
total_cost	float Total cost of the solution. The sum of all values in the costs map.

Classes

CostsEntry

CostsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.