Interface AggregatedMetricsOrBuilder (1.3.0)

public interface AggregatedMetricsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsCosts(String key)

public abstract boolean containsCosts(String key)

Deprecated: Use [ShipmentRoute.route_costs][] and [OptimizeToursResponse.Metrics.costs][] instead.

map<string, double> costs = 10 [deprecated = true];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsMaxLoads(String key)

public abstract 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
NameDescription
keyString
Returns
TypeDescription
boolean

getBreakDuration()

public abstract Duration getBreakDuration()

Total break duration for a route or a solution.

.google.protobuf.Duration break_duration = 5;

Returns
TypeDescription
Duration

The breakDuration.

getBreakDurationOrBuilder()

public abstract DurationOrBuilder getBreakDurationOrBuilder()

Total break duration for a route or a solution.

.google.protobuf.Duration break_duration = 5;

Returns
TypeDescription
DurationOrBuilder

getCosts()

public abstract Map<String,Double> getCosts()

Use #getCostsMap() instead.

Returns
TypeDescription
Map<String,Double>

getCostsCount()

public abstract int getCostsCount()

Deprecated: Use [ShipmentRoute.route_costs][] and [OptimizeToursResponse.Metrics.costs][] instead.

map<string, double> costs = 10 [deprecated = true];

Returns
TypeDescription
int

getCostsMap()

public abstract Map<String,Double> getCostsMap()

Deprecated: Use [ShipmentRoute.route_costs][] and [OptimizeToursResponse.Metrics.costs][] instead.

map<string, double> costs = 10 [deprecated = true];

Returns
TypeDescription
Map<String,Double>

getCostsOrDefault(String key, double defaultValue)

public abstract double getCostsOrDefault(String key, double defaultValue)

Deprecated: Use [ShipmentRoute.route_costs][] and [OptimizeToursResponse.Metrics.costs][] instead.

map<string, double> costs = 10 [deprecated = true];

Parameters
NameDescription
keyString
defaultValuedouble
Returns
TypeDescription
double

getCostsOrThrow(String key)

public abstract double getCostsOrThrow(String key)

Deprecated: Use [ShipmentRoute.route_costs][] and [OptimizeToursResponse.Metrics.costs][] instead.

map<string, double> costs = 10 [deprecated = true];

Parameter
NameDescription
keyString
Returns
TypeDescription
double

getDelayDuration()

public abstract Duration getDelayDuration()

Total delay duration for a route or a solution.

.google.protobuf.Duration delay_duration = 4;

Returns
TypeDescription
Duration

The delayDuration.

getDelayDurationOrBuilder()

public abstract DurationOrBuilder getDelayDurationOrBuilder()

Total delay duration for a route or a solution.

.google.protobuf.Duration delay_duration = 4;

Returns
TypeDescription
DurationOrBuilder

getMaxLoads()

public abstract Map<String,ShipmentRoute.VehicleLoad> getMaxLoads()

Use #getMaxLoadsMap() instead.

Returns
TypeDescription
Map<String,VehicleLoad>

getMaxLoadsCount()

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

getMaxLoadsMap()

public abstract 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
TypeDescription
Map<String,VehicleLoad>

getMaxLoadsOrDefault(String key, ShipmentRoute.VehicleLoad defaultValue)

public abstract 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
NameDescription
keyString
defaultValueShipmentRoute.VehicleLoad
Returns
TypeDescription
ShipmentRoute.VehicleLoad

getMaxLoadsOrThrow(String key)

public abstract 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
NameDescription
keyString
Returns
TypeDescription
ShipmentRoute.VehicleLoad

getPerformedShipmentCount()

public abstract int getPerformedShipmentCount()

Number of shipments performed. Note that a pickup and delivery pair only counts once.

int32 performed_shipment_count = 1;

Returns
TypeDescription
int

The performedShipmentCount.

getTotalCost() (deprecated)

public abstract double getTotalCost()

Deprecated. google.cloud.optimization.v1.AggregatedMetrics.total_cost is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=2206

Deprecated: Use [ShipmentRoute.route_total_cost][] and [OptimizeToursResponse.Metrics.total_cost][] instead.

double total_cost = 11 [deprecated = true];

Returns
TypeDescription
double

The totalCost.

getTotalDuration()

public abstract 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
TypeDescription
Duration

The totalDuration.

getTotalDurationOrBuilder()

public abstract 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
TypeDescription
DurationOrBuilder

getTravelDistanceMeters()

public abstract double getTravelDistanceMeters()

Total travel distance for a route or a solution.

double travel_distance_meters = 8;

Returns
TypeDescription
double

The travelDistanceMeters.

getTravelDuration()

public abstract Duration getTravelDuration()

Total travel duration for a route or a solution.

.google.protobuf.Duration travel_duration = 2;

Returns
TypeDescription
Duration

The travelDuration.

getTravelDurationOrBuilder()

public abstract DurationOrBuilder getTravelDurationOrBuilder()

Total travel duration for a route or a solution.

.google.protobuf.Duration travel_duration = 2;

Returns
TypeDescription
DurationOrBuilder

getVisitDuration()

public abstract Duration getVisitDuration()

Total visit duration for a route or a solution.

.google.protobuf.Duration visit_duration = 6;

Returns
TypeDescription
Duration

The visitDuration.

getVisitDurationOrBuilder()

public abstract DurationOrBuilder getVisitDurationOrBuilder()

Total visit duration for a route or a solution.

.google.protobuf.Duration visit_duration = 6;

Returns
TypeDescription
DurationOrBuilder

getWaitDuration()

public abstract Duration getWaitDuration()

Total wait duration for a route or a solution.

.google.protobuf.Duration wait_duration = 3;

Returns
TypeDescription
Duration

The waitDuration.

getWaitDurationOrBuilder()

public abstract DurationOrBuilder getWaitDurationOrBuilder()

Total wait duration for a route or a solution.

.google.protobuf.Duration wait_duration = 3;

Returns
TypeDescription
DurationOrBuilder

hasBreakDuration()

public abstract boolean hasBreakDuration()

Total break duration for a route or a solution.

.google.protobuf.Duration break_duration = 5;

Returns
TypeDescription
boolean

Whether the breakDuration field is set.

hasDelayDuration()

public abstract boolean hasDelayDuration()

Total delay duration for a route or a solution.

.google.protobuf.Duration delay_duration = 4;

Returns
TypeDescription
boolean

Whether the delayDuration field is set.

hasTotalDuration()

public abstract 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
TypeDescription
boolean

Whether the totalDuration field is set.

hasTravelDuration()

public abstract boolean hasTravelDuration()

Total travel duration for a route or a solution.

.google.protobuf.Duration travel_duration = 2;

Returns
TypeDescription
boolean

Whether the travelDuration field is set.

hasVisitDuration()

public abstract boolean hasVisitDuration()

Total visit duration for a route or a solution.

.google.protobuf.Duration visit_duration = 6;

Returns
TypeDescription
boolean

Whether the visitDuration field is set.

hasWaitDuration()

public abstract boolean hasWaitDuration()

Total wait duration for a route or a solution.

.google.protobuf.Duration wait_duration = 3;

Returns
TypeDescription
boolean

Whether the waitDuration field is set.