/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/optimization/v1/fleet_routing.proto
package com.google.cloud.optimization.v1;
public interface AggregatedMetricsOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.optimization.v1.AggregatedMetrics)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Number of shipments performed. Note that a pickup and delivery pair only
* counts once.
*
*
* int32 performed_shipment_count = 1;
*
* @return The performedShipmentCount.
*/
int getPerformedShipmentCount();
/**
*
*
*
* Total travel duration for a route or a solution.
*
*
* .google.protobuf.Duration travel_duration = 2;
*
* @return Whether the travelDuration field is set.
*/
boolean hasTravelDuration();
/**
*
*
*
* Total travel duration for a route or a solution.
*
*
* .google.protobuf.Duration travel_duration = 2;
*
* @return The travelDuration.
*/
com.google.protobuf.Duration getTravelDuration();
/**
*
*
*
* Total travel duration for a route or a solution.
*
*
* .google.protobuf.Duration travel_duration = 2;
*/
com.google.protobuf.DurationOrBuilder getTravelDurationOrBuilder();
/**
*
*
*
* Total wait duration for a route or a solution.
*
*
* .google.protobuf.Duration wait_duration = 3;
*
* @return Whether the waitDuration field is set.
*/
boolean hasWaitDuration();
/**
*
*
*
* Total wait duration for a route or a solution.
*
*
* .google.protobuf.Duration wait_duration = 3;
*
* @return The waitDuration.
*/
com.google.protobuf.Duration getWaitDuration();
/**
*
*
*
* Total wait duration for a route or a solution.
*
*
* .google.protobuf.Duration wait_duration = 3;
*/
com.google.protobuf.DurationOrBuilder getWaitDurationOrBuilder();
/**
*
*
*
* Total delay duration for a route or a solution.
*
*
* .google.protobuf.Duration delay_duration = 4;
*
* @return Whether the delayDuration field is set.
*/
boolean hasDelayDuration();
/**
*
*
*
* Total delay duration for a route or a solution.
*
*
* .google.protobuf.Duration delay_duration = 4;
*
* @return The delayDuration.
*/
com.google.protobuf.Duration getDelayDuration();
/**
*
*
*
* Total delay duration for a route or a solution.
*
*
* .google.protobuf.Duration delay_duration = 4;
*/
com.google.protobuf.DurationOrBuilder getDelayDurationOrBuilder();
/**
*
*
*
* Total break duration for a route or a solution.
*
*
* .google.protobuf.Duration break_duration = 5;
*
* @return Whether the breakDuration field is set.
*/
boolean hasBreakDuration();
/**
*
*
*
* Total break duration for a route or a solution.
*
*
* .google.protobuf.Duration break_duration = 5;
*
* @return The breakDuration.
*/
com.google.protobuf.Duration getBreakDuration();
/**
*
*
*
* Total break duration for a route or a solution.
*
*
* .google.protobuf.Duration break_duration = 5;
*/
com.google.protobuf.DurationOrBuilder getBreakDurationOrBuilder();
/**
*
*
*
* Total visit duration for a route or a solution.
*
*
* .google.protobuf.Duration visit_duration = 6;
*
* @return Whether the visitDuration field is set.
*/
boolean hasVisitDuration();
/**
*
*
*
* Total visit duration for a route or a solution.
*
*
* .google.protobuf.Duration visit_duration = 6;
*
* @return The visitDuration.
*/
com.google.protobuf.Duration getVisitDuration();
/**
*
*
*
* Total visit duration for a route or a solution.
*
*
* .google.protobuf.Duration visit_duration = 6;
*/
com.google.protobuf.DurationOrBuilder getVisitDurationOrBuilder();
/**
*
*
*
* The total duration should be equal to the sum of all durations above.
* For routes, it also corresponds to
* [ShipmentRoute.vehicle_end_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_end_time]
* -
* [ShipmentRoute.vehicle_start_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_start_time].
*
*
* .google.protobuf.Duration total_duration = 7;
*
* @return Whether the totalDuration field is set.
*/
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][google.cloud.optimization.v1.ShipmentRoute.vehicle_end_time]
* -
* [ShipmentRoute.vehicle_start_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_start_time].
*
*
* .google.protobuf.Duration total_duration = 7;
*
* @return The totalDuration.
*/
com.google.protobuf.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][google.cloud.optimization.v1.ShipmentRoute.vehicle_end_time]
* -
* [ShipmentRoute.vehicle_start_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_start_time].
*
*
* .google.protobuf.Duration total_duration = 7;
*/
com.google.protobuf.DurationOrBuilder getTotalDurationOrBuilder();
/**
*
*
*
* Total travel distance for a route or a solution.
*
*
* double travel_distance_meters = 8;
*
* @return The travelDistanceMeters.
*/
double getTravelDistanceMeters();
/**
*
*
*
* 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][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
* (resp.
* [ShipmentRoute.metrics.max_loads][google.cloud.optimization.v1.AggregatedMetrics.max_loads].
*
*
* map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> max_loads = 9;
*
*/
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][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
* (resp.
* [ShipmentRoute.metrics.max_loads][google.cloud.optimization.v1.AggregatedMetrics.max_loads].
*
*
* map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> max_loads = 9;
*
*/
boolean containsMaxLoads(java.lang.String key);
/** Use {@link #getMaxLoadsMap()} instead. */
@java.lang.Deprecated
java.util.Map
getMaxLoads();
/**
*
*
*
* 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][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
* (resp.
* [ShipmentRoute.metrics.max_loads][google.cloud.optimization.v1.AggregatedMetrics.max_loads].
*
*
* map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> max_loads = 9;
*
*/
java.util.Map
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][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
* (resp.
* [ShipmentRoute.metrics.max_loads][google.cloud.optimization.v1.AggregatedMetrics.max_loads].
*
*
* map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> max_loads = 9;
*
*/
/* nullable */
com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad getMaxLoadsOrDefault(
java.lang.String key,
/* nullable */
com.google.cloud.optimization.v1.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][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
* (resp.
* [ShipmentRoute.metrics.max_loads][google.cloud.optimization.v1.AggregatedMetrics.max_loads].
*
*
* map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> max_loads = 9;
*
*/
com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad getMaxLoadsOrThrow(
java.lang.String key);
/**
*
*
*
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
*
*
* map<string, double> costs = 10 [deprecated = true];
*/
@java.lang.Deprecated
int getCostsCount();
/**
*
*
*
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
*
*
* map<string, double> costs = 10 [deprecated = true];
*/
@java.lang.Deprecated
boolean containsCosts(java.lang.String key);
/** Use {@link #getCostsMap()} instead. */
@java.lang.Deprecated
java.util.Map getCosts();
/**
*
*
*
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
*
*
* map<string, double> costs = 10 [deprecated = true];
*/
@java.lang.Deprecated
java.util.Map getCostsMap();
/**
*
*
*
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
*
*
* map<string, double> costs = 10 [deprecated = true];
*/
@java.lang.Deprecated
double getCostsOrDefault(java.lang.String key, double defaultValue);
/**
*
*
*
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
*
*
* map<string, double> costs = 10 [deprecated = true];
*/
@java.lang.Deprecated
double getCostsOrThrow(java.lang.String key);
/**
*
*
*
* Deprecated: Use
* [ShipmentRoute.route_total_cost][google.cloud.optimization.v1.ShipmentRoute.route_total_cost]
* and
* [OptimizeToursResponse.Metrics.total_cost][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.total_cost]
* instead.
*
*
* double total_cost = 11 [deprecated = true];
*
* @deprecated google.cloud.optimization.v1.AggregatedMetrics.total_cost is deprecated. See
* google/cloud/optimization/v1/fleet_routing.proto;l=2331
* @return The totalCost.
*/
@java.lang.Deprecated
double getTotalCost();
}