Class OptimizeToursResponse.Metrics (1.29.0)

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
TypeDescription
int

COSTS_FIELD_NUMBER

public static final int COSTS_FIELD_NUMBER
Field Value
TypeDescription
int

EARLIEST_VEHICLE_START_TIME_FIELD_NUMBER

public static final int EARLIEST_VEHICLE_START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

LATEST_VEHICLE_END_TIME_FIELD_NUMBER

public static final int LATEST_VEHICLE_END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

SKIPPED_MANDATORY_SHIPMENT_COUNT_FIELD_NUMBER

public static final int SKIPPED_MANDATORY_SHIPMENT_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_COST_FIELD_NUMBER

public static final int TOTAL_COST_FIELD_NUMBER
Field Value
TypeDescription
int

USED_VEHICLE_COUNT_FIELD_NUMBER

public static final int USED_VEHICLE_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static OptimizeToursResponse.Metrics getDefaultInstance()
Returns
TypeDescription
OptimizeToursResponse.Metrics

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static OptimizeToursResponse.Metrics.Builder newBuilder()
Returns
TypeDescription
OptimizeToursResponse.Metrics.Builder

newBuilder(OptimizeToursResponse.Metrics prototype)

public static OptimizeToursResponse.Metrics.Builder newBuilder(OptimizeToursResponse.Metrics prototype)
Parameter
NameDescription
prototypeOptimizeToursResponse.Metrics
Returns
TypeDescription
OptimizeToursResponse.Metrics.Builder

parseDelimitedFrom(InputStream input)

public static OptimizeToursResponse.Metrics parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OptimizeToursResponse.Metrics
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OptimizeToursResponse.Metrics parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OptimizeToursResponse.Metrics
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static OptimizeToursResponse.Metrics parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
OptimizeToursResponse.Metrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OptimizeToursResponse.Metrics parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OptimizeToursResponse.Metrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OptimizeToursResponse.Metrics parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
OptimizeToursResponse.Metrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OptimizeToursResponse.Metrics parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OptimizeToursResponse.Metrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OptimizeToursResponse.Metrics parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
OptimizeToursResponse.Metrics
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OptimizeToursResponse.Metrics parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OptimizeToursResponse.Metrics
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static OptimizeToursResponse.Metrics parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OptimizeToursResponse.Metrics
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OptimizeToursResponse.Metrics parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OptimizeToursResponse.Metrics
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static OptimizeToursResponse.Metrics parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
OptimizeToursResponse.Metrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OptimizeToursResponse.Metrics parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OptimizeToursResponse.Metrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<OptimizeToursResponse.Metrics> parser()
Returns
TypeDescription
Parser<Metrics>

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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;

Returns
TypeDescription
AggregatedMetrics

The aggregatedRouteMetrics.

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;

Returns
TypeDescription
AggregatedMetricsOrBuilder

getCosts() (deprecated)

public Map<String,Double> getCosts()

Use #getCostsMap() instead.

Returns
TypeDescription
Map<String,Double>

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;

Returns
TypeDescription
int

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;

Returns
TypeDescription
Map<String,Double>

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;

Parameters
NameDescription
keyString
defaultValuedouble
Returns
TypeDescription
double

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
double

getDefaultInstanceForType()

public OptimizeToursResponse.Metrics getDefaultInstanceForType()
Returns
TypeDescription
OptimizeToursResponse.Metrics

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;

Returns
TypeDescription
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;

Returns
TypeDescription
TimestampOrBuilder

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;

Returns
TypeDescription
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;

Returns
TypeDescription
TimestampOrBuilder

getParserForType()

public Parser<OptimizeToursResponse.Metrics> getParserForType()
Returns
TypeDescription
Parser<Metrics>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSkippedMandatoryShipmentCount()

public int getSkippedMandatoryShipmentCount()

Number of mandatory shipments skipped.

int32 skipped_mandatory_shipment_count = 2;

Returns
TypeDescription
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;

Returns
TypeDescription
double

The totalCost.

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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
boolean

Whether the latestVehicleEndTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public OptimizeToursResponse.Metrics.Builder newBuilderForType()
Returns
TypeDescription
OptimizeToursResponse.Metrics.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OptimizeToursResponse.Metrics.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
OptimizeToursResponse.Metrics.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public OptimizeToursResponse.Metrics.Builder toBuilder()
Returns
TypeDescription
OptimizeToursResponse.Metrics.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException