Package com.google.cloud.optimization.v1

Interface OptimizeToursResponse.MetricsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
OptimizeToursResponse.Metrics, OptimizeToursResponse.Metrics.Builder
Enclosing class:
OptimizeToursResponse
public static interface OptimizeToursResponse.MetricsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsCosts(String key)
    Cost of the solution, broken down by cost-related request fields.
    AggregatedMetrics
    getAggregatedRouteMetrics()
    Aggregated over the routes.
    AggregatedMetricsOrBuilder
    getAggregatedRouteMetricsOrBuilder()
    Aggregated over the routes.
    Map<String,Double>
    getCosts()
    Deprecated.
    int
    getCostsCount()
    Cost of the solution, broken down by cost-related request fields.
    Map<String,Double>
    getCostsMap()
    Cost of the solution, broken down by cost-related request fields.
    double
    getCostsOrDefault(String key, double defaultValue)
    Cost of the solution, broken down by cost-related request fields.
    double
    getCostsOrThrow(String key)
    Cost of the solution, broken down by cost-related request fields.
    com.google.protobuf.Timestamp
    getEarliestVehicleStartTime()
    The earliest start time for a used vehicle, computed as the minimum over all used vehicles of [ShipmentRoute.vehicle_start_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_start_time].
    com.google.protobuf.TimestampOrBuilder
    getEarliestVehicleStartTimeOrBuilder()
    The earliest start time for a used vehicle, computed as the minimum over all used vehicles of [ShipmentRoute.vehicle_start_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_start_time].
    com.google.protobuf.Timestamp
    getLatestVehicleEndTime()
    The latest end time for a used vehicle, computed as the maximum over all used vehicles of [ShipmentRoute.vehicle_end_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_end_time].
    com.google.protobuf.TimestampOrBuilder
    getLatestVehicleEndTimeOrBuilder()
    The latest end time for a used vehicle, computed as the maximum over all used vehicles of [ShipmentRoute.vehicle_end_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_end_time].
    int
    getSkippedMandatoryShipmentCount()
    Number of mandatory shipments skipped.
    double
    getTotalCost()
    Total cost of the solution.
    int
    getUsedVehicleCount()
    Number of vehicles used.
    boolean
    hasAggregatedRouteMetrics()
    Aggregated over the routes.
    boolean
    hasEarliestVehicleStartTime()
    The earliest start time for a used vehicle, computed as the minimum over all used vehicles of [ShipmentRoute.vehicle_start_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_start_time].
    boolean
    hasLatestVehicleEndTime()
    The latest end time for a used vehicle, computed as the maximum over all used vehicles of [ShipmentRoute.vehicle_end_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_end_time].

    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

    • hasAggregatedRouteMetrics

      boolean hasAggregatedRouteMetrics()
       Aggregated over the routes. Each metric is the sum (or max, for loads)
 over all
 [ShipmentRoute.metrics][google.cloud.optimization.v1.ShipmentRoute.metrics]
 fields of the same name.
      .google.cloud.optimization.v1.AggregatedMetrics aggregated_route_metrics = 1;
      Returns:
      Whether the aggregatedRouteMetrics field is set.

    • getAggregatedRouteMetrics

      AggregatedMetrics getAggregatedRouteMetrics()
       Aggregated over the routes. Each metric is the sum (or max, for loads)
 over all
 [ShipmentRoute.metrics][google.cloud.optimization.v1.ShipmentRoute.metrics]
 fields of the same name.
      .google.cloud.optimization.v1.AggregatedMetrics aggregated_route_metrics = 1;
      Returns:
      The aggregatedRouteMetrics.

    • getAggregatedRouteMetricsOrBuilder

      AggregatedMetricsOrBuilder getAggregatedRouteMetricsOrBuilder()
       Aggregated over the routes. Each metric is the sum (or max, for loads)
 over all
 [ShipmentRoute.metrics][google.cloud.optimization.v1.ShipmentRoute.metrics]
 fields of the same name.
      .google.cloud.optimization.v1.AggregatedMetrics aggregated_route_metrics = 1;

    • getSkippedMandatoryShipmentCount

      int getSkippedMandatoryShipmentCount()
       Number of mandatory shipments skipped.
      int32 skipped_mandatory_shipment_count = 2;
      Returns:
      The skippedMandatoryShipmentCount.

    • getUsedVehicleCount

      int getUsedVehicleCount()
       Number of vehicles used. Note: if a vehicle route is empty and
 [Vehicle.used_if_route_is_empty][google.cloud.optimization.v1.Vehicle.used_if_route_is_empty]
 is true, the vehicle is considered used.
      int32 used_vehicle_count = 3;
      Returns:
      The usedVehicleCount.

    • hasEarliestVehicleStartTime

      boolean hasEarliestVehicleStartTime()
       The earliest start time for a used vehicle, computed as the minimum over
 all used vehicles of
 [ShipmentRoute.vehicle_start_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_start_time].
      .google.protobuf.Timestamp earliest_vehicle_start_time = 4;
      Returns:
      Whether the earliestVehicleStartTime field is set.

    • getEarliestVehicleStartTime

      com.google.protobuf.Timestamp getEarliestVehicleStartTime()
       The earliest start time for a used vehicle, computed as the minimum over
 all used vehicles of
 [ShipmentRoute.vehicle_start_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_start_time].
      .google.protobuf.Timestamp earliest_vehicle_start_time = 4;
      Returns:
      The earliestVehicleStartTime.

    • getEarliestVehicleStartTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getEarliestVehicleStartTimeOrBuilder()
       The earliest start time for a used vehicle, computed as the minimum over
 all used vehicles of
 [ShipmentRoute.vehicle_start_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_start_time].
      .google.protobuf.Timestamp earliest_vehicle_start_time = 4;

    • hasLatestVehicleEndTime

      boolean hasLatestVehicleEndTime()
       The latest end time for a used vehicle, computed as the maximum over all
 used vehicles of
 [ShipmentRoute.vehicle_end_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_end_time].
      .google.protobuf.Timestamp latest_vehicle_end_time = 5;
      Returns:
      Whether the latestVehicleEndTime field is set.

    • getLatestVehicleEndTime

      com.google.protobuf.Timestamp getLatestVehicleEndTime()
       The latest end time for a used vehicle, computed as the maximum over all
 used vehicles of
 [ShipmentRoute.vehicle_end_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_end_time].
      .google.protobuf.Timestamp latest_vehicle_end_time = 5;
      Returns:
      The latestVehicleEndTime.

    • getLatestVehicleEndTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getLatestVehicleEndTimeOrBuilder()
       The latest end time for a used vehicle, computed as the maximum over all
 used vehicles of
 [ShipmentRoute.vehicle_end_time][google.cloud.optimization.v1.ShipmentRoute.vehicle_end_time].
      .google.protobuf.Timestamp latest_vehicle_end_time = 5;

    • getCostsCount

      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;

    • containsCosts

      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;

    • getCosts

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

    • getCostsMap

      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;

    • getCostsOrDefault

      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;

    • getCostsOrThrow

      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;

    • getTotalCost

      double getTotalCost()
       Total cost of the solution. The sum of all values in the costs map.
      double total_cost = 6;
      Returns:
      The totalCost.