public final class AggregatedMetrics extends GeneratedMessageV3 implements AggregatedMetricsOrBuilder
Aggregated metrics for ShipmentRoute (resp. for OptimizeToursResponse
over all Transition
and/or Visit (resp. over
all ShipmentRoute) elements.
Protobuf type google.cloud.optimization.v1.AggregatedMetrics
Static Fields
BREAK_DURATION_FIELD_NUMBER
public static final int BREAK_DURATION_FIELD_NUMBER
Field Value
COSTS_FIELD_NUMBER
public static final int COSTS_FIELD_NUMBER
Field Value
DELAY_DURATION_FIELD_NUMBER
public static final int DELAY_DURATION_FIELD_NUMBER
Field Value
MAX_LOADS_FIELD_NUMBER
public static final int MAX_LOADS_FIELD_NUMBER
Field Value
public static final int PERFORMED_SHIPMENT_COUNT_FIELD_NUMBER
Field Value
TOTAL_COST_FIELD_NUMBER
public static final int TOTAL_COST_FIELD_NUMBER
Field Value
TOTAL_DURATION_FIELD_NUMBER
public static final int TOTAL_DURATION_FIELD_NUMBER
Field Value
TRAVEL_DISTANCE_METERS_FIELD_NUMBER
public static final int TRAVEL_DISTANCE_METERS_FIELD_NUMBER
Field Value
TRAVEL_DURATION_FIELD_NUMBER
public static final int TRAVEL_DURATION_FIELD_NUMBER
Field Value
VISIT_DURATION_FIELD_NUMBER
public static final int VISIT_DURATION_FIELD_NUMBER
Field Value
WAIT_DURATION_FIELD_NUMBER
public static final int WAIT_DURATION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AggregatedMetrics getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AggregatedMetrics.Builder newBuilder()
Returns
newBuilder(AggregatedMetrics prototype)
public static AggregatedMetrics.Builder newBuilder(AggregatedMetrics prototype)
Parameter
Returns
public static AggregatedMetrics parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AggregatedMetrics parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AggregatedMetrics parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AggregatedMetrics parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AggregatedMetrics parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AggregatedMetrics parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AggregatedMetrics parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AggregatedMetrics parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AggregatedMetrics parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AggregatedMetrics parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AggregatedMetrics parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AggregatedMetrics parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AggregatedMetrics> parser()
Returns
Methods
containsCosts(String key)
public boolean containsCosts(String key)
Deprecated: Use [ShipmentRoute.route_costs][] and [OptimizeToursResponse.Metrics.costs][] instead.
map<string, double> costs = 10 [deprecated = true];
Parameter
Returns
containsMaxLoads(String key)
public boolean containsMaxLoads(String key)
Maximum load achieved over the entire route (resp. solution), for each of
the quantities on this route (resp. solution), computed as the maximum over
all
Transition.vehicle_loads
(resp.
ShipmentRoute.metrics.max_loads.
map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> max_loads = 9;
Parameter
Returns
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getBreakDuration()
public Duration getBreakDuration()
Total break duration for a route or a solution.
.google.protobuf.Duration break_duration = 5;
Returns
Type | Description |
Duration | The breakDuration.
|
getBreakDurationOrBuilder()
public DurationOrBuilder getBreakDurationOrBuilder()
Total break duration for a route or a solution.
.google.protobuf.Duration break_duration = 5;
Returns
getCosts()
public Map<String,Double> getCosts()
Returns
getCostsCount()
public int getCostsCount()
Deprecated: Use [ShipmentRoute.route_costs][] and [OptimizeToursResponse.Metrics.costs][] instead.
map<string, double> costs = 10 [deprecated = true];
Returns
getCostsMap()
public Map<String,Double> getCostsMap()
Deprecated: Use [ShipmentRoute.route_costs][] and [OptimizeToursResponse.Metrics.costs][] instead.
map<string, double> costs = 10 [deprecated = true];
Returns
getCostsOrDefault(String key, double defaultValue)
public double getCostsOrDefault(String key, double defaultValue)
Deprecated: Use [ShipmentRoute.route_costs][] and [OptimizeToursResponse.Metrics.costs][] instead.
map<string, double> costs = 10 [deprecated = true];
Parameters
Returns
getCostsOrThrow(String key)
public double getCostsOrThrow(String key)
Deprecated: Use [ShipmentRoute.route_costs][] and [OptimizeToursResponse.Metrics.costs][] instead.
map<string, double> costs = 10 [deprecated = true];
Parameter
Returns
getDefaultInstanceForType()
public AggregatedMetrics getDefaultInstanceForType()
Returns
getDelayDuration()
public Duration getDelayDuration()
Total delay duration for a route or a solution.
.google.protobuf.Duration delay_duration = 4;
Returns
Type | Description |
Duration | The delayDuration.
|
getDelayDurationOrBuilder()
public DurationOrBuilder getDelayDurationOrBuilder()
Total delay duration for a route or a solution.
.google.protobuf.Duration delay_duration = 4;
Returns
getMaxLoads()
public Map<String,ShipmentRoute.VehicleLoad> getMaxLoads()
Returns
getMaxLoadsCount()
public int getMaxLoadsCount()
Maximum load achieved over the entire route (resp. solution), for each of
the quantities on this route (resp. solution), computed as the maximum over
all
Transition.vehicle_loads
(resp.
ShipmentRoute.metrics.max_loads.
map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> max_loads = 9;
Returns
getMaxLoadsMap()
public Map<String,ShipmentRoute.VehicleLoad> getMaxLoadsMap()
Maximum load achieved over the entire route (resp. solution), for each of
the quantities on this route (resp. solution), computed as the maximum over
all
Transition.vehicle_loads
(resp.
ShipmentRoute.metrics.max_loads.
map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> max_loads = 9;
Returns
getMaxLoadsOrDefault(String key, ShipmentRoute.VehicleLoad defaultValue)
public ShipmentRoute.VehicleLoad getMaxLoadsOrDefault(String key, ShipmentRoute.VehicleLoad defaultValue)
Maximum load achieved over the entire route (resp. solution), for each of
the quantities on this route (resp. solution), computed as the maximum over
all
Transition.vehicle_loads
(resp.
ShipmentRoute.metrics.max_loads.
map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> max_loads = 9;
Parameters
Returns
getMaxLoadsOrThrow(String key)
public ShipmentRoute.VehicleLoad getMaxLoadsOrThrow(String key)
Maximum load achieved over the entire route (resp. solution), for each of
the quantities on this route (resp. solution), computed as the maximum over
all
Transition.vehicle_loads
(resp.
ShipmentRoute.metrics.max_loads.
map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> max_loads = 9;
Parameter
Returns
getParserForType()
public Parser<AggregatedMetrics> getParserForType()
Returns
Overrides
public int getPerformedShipmentCount()
Number of shipments performed. Note that a pickup and delivery pair only
counts once.
int32 performed_shipment_count = 1;
Returns
Type | Description |
int | The performedShipmentCount.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTotalCost()
public double getTotalCost()
Deprecated: Use [ShipmentRoute.route_total_cost][] and [OptimizeToursResponse.Metrics.total_cost][] instead.
double total_cost = 11 [deprecated = true];
Returns
Type | Description |
double | The totalCost.
|
getTotalDuration()
public Duration getTotalDuration()
The total duration should be equal to the sum of all durations above.
For routes, it also corresponds to ShipmentRoute.vehicle_end_time -
ShipmentRoute.vehicle_start_time.
.google.protobuf.Duration total_duration = 7;
Returns
Type | Description |
Duration | The totalDuration.
|
getTotalDurationOrBuilder()
public DurationOrBuilder getTotalDurationOrBuilder()
The total duration should be equal to the sum of all durations above.
For routes, it also corresponds to ShipmentRoute.vehicle_end_time -
ShipmentRoute.vehicle_start_time.
.google.protobuf.Duration total_duration = 7;
Returns
getTravelDistanceMeters()
public double getTravelDistanceMeters()
Total travel distance for a route or a solution.
double travel_distance_meters = 8;
Returns
Type | Description |
double | The travelDistanceMeters.
|
getTravelDuration()
public Duration getTravelDuration()
Total travel duration for a route or a solution.
.google.protobuf.Duration travel_duration = 2;
Returns
Type | Description |
Duration | The travelDuration.
|
getTravelDurationOrBuilder()
public DurationOrBuilder getTravelDurationOrBuilder()
Total travel duration for a route or a solution.
.google.protobuf.Duration travel_duration = 2;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getVisitDuration()
public Duration getVisitDuration()
Total visit duration for a route or a solution.
.google.protobuf.Duration visit_duration = 6;
Returns
Type | Description |
Duration | The visitDuration.
|
getVisitDurationOrBuilder()
public DurationOrBuilder getVisitDurationOrBuilder()
Total visit duration for a route or a solution.
.google.protobuf.Duration visit_duration = 6;
Returns
getWaitDuration()
public Duration getWaitDuration()
Total wait duration for a route or a solution.
.google.protobuf.Duration wait_duration = 3;
Returns
Type | Description |
Duration | The waitDuration.
|
getWaitDurationOrBuilder()
public DurationOrBuilder getWaitDurationOrBuilder()
Total wait duration for a route or a solution.
.google.protobuf.Duration wait_duration = 3;
Returns
hasBreakDuration()
public boolean hasBreakDuration()
Total break duration for a route or a solution.
.google.protobuf.Duration break_duration = 5;
Returns
Type | Description |
boolean | Whether the breakDuration field is set.
|
hasDelayDuration()
public boolean hasDelayDuration()
Total delay duration for a route or a solution.
.google.protobuf.Duration delay_duration = 4;
Returns
Type | Description |
boolean | Whether the delayDuration field is set.
|
hasTotalDuration()
public boolean hasTotalDuration()
The total duration should be equal to the sum of all durations above.
For routes, it also corresponds to ShipmentRoute.vehicle_end_time -
ShipmentRoute.vehicle_start_time.
.google.protobuf.Duration total_duration = 7;
Returns
Type | Description |
boolean | Whether the totalDuration field is set.
|
hasTravelDuration()
public boolean hasTravelDuration()
Total travel duration for a route or a solution.
.google.protobuf.Duration travel_duration = 2;
Returns
Type | Description |
boolean | Whether the travelDuration field is set.
|
hasVisitDuration()
public boolean hasVisitDuration()
Total visit duration for a route or a solution.
.google.protobuf.Duration visit_duration = 6;
Returns
Type | Description |
boolean | Whether the visitDuration field is set.
|
hasWaitDuration()
public boolean hasWaitDuration()
Total wait duration for a route or a solution.
.google.protobuf.Duration wait_duration = 3;
Returns
Type | Description |
boolean | Whether the waitDuration 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 AggregatedMetrics.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AggregatedMetrics.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AggregatedMetrics.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions