public static final class OptimizeToursResponse.Metrics extends GeneratedMessageV3 implements OptimizeToursResponse.MetricsOrBuilder
Overall metrics, aggregated over all routes.
Protobuf type google.cloud.optimization.v1.OptimizeToursResponse.Metrics
Static Fields
AGGREGATED_ROUTE_METRICS_FIELD_NUMBER
public static final int AGGREGATED_ROUTE_METRICS_FIELD_NUMBER
Field Value
COSTS_FIELD_NUMBER
public static final int COSTS_FIELD_NUMBER
Field Value
EARLIEST_VEHICLE_START_TIME_FIELD_NUMBER
public static final int EARLIEST_VEHICLE_START_TIME_FIELD_NUMBER
Field Value
LATEST_VEHICLE_END_TIME_FIELD_NUMBER
public static final int LATEST_VEHICLE_END_TIME_FIELD_NUMBER
Field Value
SKIPPED_MANDATORY_SHIPMENT_COUNT_FIELD_NUMBER
public static final int SKIPPED_MANDATORY_SHIPMENT_COUNT_FIELD_NUMBER
Field Value
TOTAL_COST_FIELD_NUMBER
public static final int TOTAL_COST_FIELD_NUMBER
Field Value
USED_VEHICLE_COUNT_FIELD_NUMBER
public static final int USED_VEHICLE_COUNT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static OptimizeToursResponse.Metrics getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static OptimizeToursResponse.Metrics.Builder newBuilder()
Returns
newBuilder(OptimizeToursResponse.Metrics prototype)
public static OptimizeToursResponse.Metrics.Builder newBuilder(OptimizeToursResponse.Metrics prototype)
Parameter
Returns
public static OptimizeToursResponse.Metrics parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static OptimizeToursResponse.Metrics parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static OptimizeToursResponse.Metrics parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static OptimizeToursResponse.Metrics parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static OptimizeToursResponse.Metrics parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static OptimizeToursResponse.Metrics parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static OptimizeToursResponse.Metrics parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static OptimizeToursResponse.Metrics parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static OptimizeToursResponse.Metrics parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static OptimizeToursResponse.Metrics parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static OptimizeToursResponse.Metrics parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static OptimizeToursResponse.Metrics parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<OptimizeToursResponse.Metrics> parser()
Returns
Methods
containsCosts(String key)
public boolean containsCosts(String key)
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.
map<string, double> costs = 10;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAggregatedRouteMetrics()
public AggregatedMetrics getAggregatedRouteMetrics()
Aggregated over the routes. Each metric is the sum (or max, for loads)
over all ShipmentRoute.metrics fields of the same name.
.google.cloud.optimization.v1.AggregatedMetrics aggregated_route_metrics = 1;
getAggregatedRouteMetricsOrBuilder()
public AggregatedMetricsOrBuilder getAggregatedRouteMetricsOrBuilder()
Aggregated over the routes. Each metric is the sum (or max, for loads)
over all ShipmentRoute.metrics fields of the same name.
.google.cloud.optimization.v1.AggregatedMetrics aggregated_route_metrics = 1;
getCosts()
public Map<String,Double> getCosts()
Returns
getCostsCount()
public int getCostsCount()
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.
map<string, double> costs = 10;
getCostsMap()
public Map<String,Double> getCostsMap()
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.
map<string, double> costs = 10;
getCostsOrDefault(String key, double defaultValue)
public double getCostsOrDefault(String key, double defaultValue)
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.
map<string, double> costs = 10;
getCostsOrThrow(String key)
public double getCostsOrThrow(String key)
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.
map<string, double> costs = 10;
getDefaultInstanceForType()
public OptimizeToursResponse.Metrics getDefaultInstanceForType()
Returns
getEarliestVehicleStartTime()
public Timestamp getEarliestVehicleStartTime()
The earliest start time for a used vehicle, computed as the minimum over
all used vehicles of ShipmentRoute.vehicle_start_time.
.google.protobuf.Timestamp earliest_vehicle_start_time = 4;
| Type | Description |
| Timestamp | The earliestVehicleStartTime.
|
getEarliestVehicleStartTimeOrBuilder()
public TimestampOrBuilder getEarliestVehicleStartTimeOrBuilder()
The earliest start time for a used vehicle, computed as the minimum over
all used vehicles of ShipmentRoute.vehicle_start_time.
.google.protobuf.Timestamp earliest_vehicle_start_time = 4;
getLatestVehicleEndTime()
public Timestamp getLatestVehicleEndTime()
The latest end time for a used vehicle, computed as the maximum over all
used vehicles of ShipmentRoute.vehicle_end_time.
.google.protobuf.Timestamp latest_vehicle_end_time = 5;
| Type | Description |
| Timestamp | The latestVehicleEndTime.
|
getLatestVehicleEndTimeOrBuilder()
public TimestampOrBuilder getLatestVehicleEndTimeOrBuilder()
The latest end time for a used vehicle, computed as the maximum over all
used vehicles of ShipmentRoute.vehicle_end_time.
.google.protobuf.Timestamp latest_vehicle_end_time = 5;
getParserForType()
public Parser<OptimizeToursResponse.Metrics> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSkippedMandatoryShipmentCount()
public int getSkippedMandatoryShipmentCount()
Number of mandatory shipments skipped.
int32 skipped_mandatory_shipment_count = 2;
| Type | Description |
| int | The skippedMandatoryShipmentCount.
|
getTotalCost()
public double getTotalCost()
Total cost of the solution. The sum of all values in the costs map.
double total_cost = 6;
| Type | Description |
| double | The totalCost.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUsedVehicleCount()
public int getUsedVehicleCount()
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.
int32 used_vehicle_count = 3;
| Type | Description |
| int | The usedVehicleCount.
|
hasAggregatedRouteMetrics()
public boolean hasAggregatedRouteMetrics()
Aggregated over the routes. Each metric is the sum (or max, for loads)
over all ShipmentRoute.metrics fields of the same name.
.google.cloud.optimization.v1.AggregatedMetrics aggregated_route_metrics = 1;
| Type | Description |
| boolean | Whether the aggregatedRouteMetrics field is set.
|
hasEarliestVehicleStartTime()
public boolean hasEarliestVehicleStartTime()
The earliest start time for a used vehicle, computed as the minimum over
all used vehicles of ShipmentRoute.vehicle_start_time.
.google.protobuf.Timestamp earliest_vehicle_start_time = 4;
| Type | Description |
| boolean | Whether the earliestVehicleStartTime field is set.
|
hasLatestVehicleEndTime()
public boolean hasLatestVehicleEndTime()
The latest end time for a used vehicle, computed as the maximum over all
used vehicles of ShipmentRoute.vehicle_end_time.
.google.protobuf.Timestamp latest_vehicle_end_time = 5;
| Type | Description |
| boolean | Whether the latestVehicleEndTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public OptimizeToursResponse.Metrics.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected OptimizeToursResponse.Metrics.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public OptimizeToursResponse.Metrics.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
