Package com.google.cloud.optimization.v1

Interface AggregatedMetricsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AggregatedMetrics, AggregatedMetrics.Builder
@Generated public interface AggregatedMetricsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsCosts(String key)
    Deprecated.
    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][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads] (resp.
    com.google.protobuf.Duration
    getBreakDuration()
    Total break duration for a route or a solution.
    com.google.protobuf.DurationOrBuilder
    getBreakDurationOrBuilder()
    Total break duration for a route or a solution.
    Map<String,Double>
    getCosts()
    Deprecated.
    int
    getCostsCount()
    Deprecated.
    Map<String,Double>
    getCostsMap()
    Deprecated.
    double
    getCostsOrDefault(String key, double defaultValue)
    Deprecated.
    double
    getCostsOrThrow(String key)
    Deprecated.
    com.google.protobuf.Duration
    getDelayDuration()
    Total delay duration for a route or a solution.
    com.google.protobuf.DurationOrBuilder
    getDelayDurationOrBuilder()
    Total delay duration for a route or a solution.
    Map<String,ShipmentRoute.VehicleLoad>
    getMaxLoads()
    Deprecated.
    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.
    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][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads] (resp.
    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][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads] (resp.
    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][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads] (resp.
    int
    getPerformedShipmentCount()
    Number of shipments performed.
    double
    getTotalCost()
    Deprecated.
    google.cloud.optimization.v1.AggregatedMetrics.total_cost is deprecated.
    com.google.protobuf.Duration
    getTotalDuration()
    The total duration should be equal to the sum of all durations above.
    com.google.protobuf.DurationOrBuilder
    getTotalDurationOrBuilder()
    The total duration should be equal to the sum of all durations above.
    double
    getTravelDistanceMeters()
    Total travel distance for a route or a solution.
    com.google.protobuf.Duration
    getTravelDuration()
    Total travel duration for a route or a solution.
    com.google.protobuf.DurationOrBuilder
    getTravelDurationOrBuilder()
    Total travel duration for a route or a solution.
    com.google.protobuf.Duration
    getVisitDuration()
    Total visit duration for a route or a solution.
    com.google.protobuf.DurationOrBuilder
    getVisitDurationOrBuilder()
    Total visit duration for a route or a solution.
    com.google.protobuf.Duration
    getWaitDuration()
    Total wait duration for a route or a solution.
    com.google.protobuf.DurationOrBuilder
    getWaitDurationOrBuilder()
    Total wait duration for a route or a solution.
    boolean
    hasBreakDuration()
    Total break duration for a route or a solution.
    boolean
    hasDelayDuration()
    Total delay duration for a route or a solution.
    boolean
    hasTotalDuration()
    The total duration should be equal to the sum of all durations above.
    boolean
    hasTravelDuration()
    Total travel duration for a route or a solution.
    boolean
    hasVisitDuration()
    Total visit duration for a route or a solution.
    boolean
    hasWaitDuration()
    Total wait duration for a route or a solution.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getPerformedShipmentCount

      int getPerformedShipmentCount()
       Number of shipments performed. Note that a pickup and delivery pair only
 counts once.
      int32 performed_shipment_count = 1;
      Returns:
      The performedShipmentCount.

    • hasTravelDuration

      boolean hasTravelDuration()
       Total travel duration for a route or a solution.
      .google.protobuf.Duration travel_duration = 2;
      Returns:
      Whether the travelDuration field is set.

    • getTravelDuration

      com.google.protobuf.Duration getTravelDuration()
       Total travel duration for a route or a solution.
      .google.protobuf.Duration travel_duration = 2;
      Returns:
      The travelDuration.

    • getTravelDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getTravelDurationOrBuilder()
       Total travel duration for a route or a solution.
      .google.protobuf.Duration travel_duration = 2;

    • hasWaitDuration

      boolean hasWaitDuration()
       Total wait duration for a route or a solution.
      .google.protobuf.Duration wait_duration = 3;
      Returns:
      Whether the waitDuration field is set.

    • getWaitDuration

      com.google.protobuf.Duration getWaitDuration()
       Total wait duration for a route or a solution.
      .google.protobuf.Duration wait_duration = 3;
      Returns:
      The waitDuration.

    • getWaitDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getWaitDurationOrBuilder()
       Total wait duration for a route or a solution.
      .google.protobuf.Duration wait_duration = 3;

    • hasDelayDuration

      boolean hasDelayDuration()
       Total delay duration for a route or a solution.
      .google.protobuf.Duration delay_duration = 4;
      Returns:
      Whether the delayDuration field is set.

    • getDelayDuration

      com.google.protobuf.Duration getDelayDuration()
       Total delay duration for a route or a solution.
      .google.protobuf.Duration delay_duration = 4;
      Returns:
      The delayDuration.

    • getDelayDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getDelayDurationOrBuilder()
       Total delay duration for a route or a solution.
      .google.protobuf.Duration delay_duration = 4;

    • hasBreakDuration

      boolean hasBreakDuration()
       Total break duration for a route or a solution.
      .google.protobuf.Duration break_duration = 5;
      Returns:
      Whether the breakDuration field is set.

    • getBreakDuration

      com.google.protobuf.Duration getBreakDuration()
       Total break duration for a route or a solution.
      .google.protobuf.Duration break_duration = 5;
      Returns:
      The breakDuration.

    • getBreakDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getBreakDurationOrBuilder()
       Total break duration for a route or a solution.
      .google.protobuf.Duration break_duration = 5;

    • hasVisitDuration

      boolean hasVisitDuration()
       Total visit duration for a route or a solution.
      .google.protobuf.Duration visit_duration = 6;
      Returns:
      Whether the visitDuration field is set.

    • getVisitDuration

      com.google.protobuf.Duration getVisitDuration()
       Total visit duration for a route or a solution.
      .google.protobuf.Duration visit_duration = 6;
      Returns:
      The visitDuration.

    • getVisitDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getVisitDurationOrBuilder()
       Total visit duration for a route or a solution.
      .google.protobuf.Duration visit_duration = 6;

    • hasTotalDuration

      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;
      Returns:
      Whether the totalDuration field is set.

    • getTotalDuration

      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;
      Returns:
      The totalDuration.

    • getTotalDurationOrBuilder

      com.google.protobuf.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][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;

    • getTravelDistanceMeters

      double getTravelDistanceMeters()
       Total travel distance for a route or a solution.
      double travel_distance_meters = 8;
      Returns:
      The travelDistanceMeters.

    • getMaxLoadsCount

      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;

    • containsMaxLoads

      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][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;

    • getMaxLoads

      @Deprecated Map<String,ShipmentRoute.VehicleLoad> getMaxLoads()
      Deprecated.
      Use getMaxLoadsMap() instead.

    • getMaxLoadsMap

      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][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;

    • getMaxLoadsOrDefault

      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][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;

    • getMaxLoadsOrThrow

      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][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;

    • getCostsCount

      @Deprecated int getCostsCount()
      Deprecated.
       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];

    • containsCosts

      @Deprecated boolean containsCosts(String key)
      Deprecated.
       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];

    • getCosts

      @Deprecated Map<String,Double> getCosts()
      Deprecated.
      Use getCostsMap() instead.

    • getCostsMap

      @Deprecated Map<String,Double> getCostsMap()
      Deprecated.
       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];

    • getCostsOrDefault

      @Deprecated double getCostsOrDefault(String key, double defaultValue)
      Deprecated.
       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];

    • getCostsOrThrow

      @Deprecated double getCostsOrThrow(String key)
      Deprecated.
       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];

    • getTotalCost

      @Deprecated double getTotalCost()
      Deprecated.
      google.cloud.optimization.v1.AggregatedMetrics.total_cost is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=2381
       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];
      Returns:
      The totalCost.