Package com.google.cloud.optimization.v1

Class OptimizeToursResponse.Metrics.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<OptimizeToursResponse.Metrics.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<OptimizeToursResponse.Metrics.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<OptimizeToursResponse.Metrics.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<OptimizeToursResponse.Metrics.Builder>

      • getDefaultInstanceForType

        public OptimizeToursResponse.Metrics getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public OptimizeToursResponse.Metrics build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public OptimizeToursResponse.Metrics buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<OptimizeToursResponse.Metrics.Builder>

      • mergeFrom

        public OptimizeToursResponse.Metrics.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OptimizeToursResponse.Metrics.Builder>
        Throws:
        IOException

      • hasAggregatedRouteMetrics

        public 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;
        Specified by:
        hasAggregatedRouteMetrics in interface OptimizeToursResponse.MetricsOrBuilder
        Returns:
        Whether the aggregatedRouteMetrics field is set.

      • getAggregatedRouteMetrics

        public 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;
        Specified by:
        getAggregatedRouteMetrics in interface OptimizeToursResponse.MetricsOrBuilder
        Returns:
        The aggregatedRouteMetrics.

      • setAggregatedRouteMetrics

        public OptimizeToursResponse.Metrics.Builder setAggregatedRouteMetrics​(AggregatedMetrics value)
         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;

      • setAggregatedRouteMetrics

        public OptimizeToursResponse.Metrics.Builder setAggregatedRouteMetrics​(AggregatedMetrics.Builder builderForValue)
         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;

      • mergeAggregatedRouteMetrics

        public OptimizeToursResponse.Metrics.Builder mergeAggregatedRouteMetrics​(AggregatedMetrics value)
         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;

      • clearAggregatedRouteMetrics

        public OptimizeToursResponse.Metrics.Builder clearAggregatedRouteMetrics()
         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;

      • getAggregatedRouteMetricsBuilder

        public AggregatedMetrics.Builder getAggregatedRouteMetricsBuilder()
         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;

      • setSkippedMandatoryShipmentCount

        public OptimizeToursResponse.Metrics.Builder setSkippedMandatoryShipmentCount​(int value)
         Number of mandatory shipments skipped.
        int32 skipped_mandatory_shipment_count = 2;
        Parameters:
        value - The skippedMandatoryShipmentCount to set.
        Returns:
        This builder for chaining.

      • clearSkippedMandatoryShipmentCount

        public OptimizeToursResponse.Metrics.Builder clearSkippedMandatoryShipmentCount()
         Number of mandatory shipments skipped.
        int32 skipped_mandatory_shipment_count = 2;
        Returns:
        This builder for chaining.

      • getUsedVehicleCount

        public 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;
        Specified by:
        getUsedVehicleCount in interface OptimizeToursResponse.MetricsOrBuilder
        Returns:
        The usedVehicleCount.

      • setUsedVehicleCount

        public OptimizeToursResponse.Metrics.Builder setUsedVehicleCount​(int value)
         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;
        Parameters:
        value - The usedVehicleCount to set.
        Returns:
        This builder for chaining.

      • clearUsedVehicleCount

        public OptimizeToursResponse.Metrics.Builder clearUsedVehicleCount()
         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:
        This builder for chaining.

      • hasEarliestVehicleStartTime

        public 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;
        Specified by:
        hasEarliestVehicleStartTime in interface OptimizeToursResponse.MetricsOrBuilder
        Returns:
        Whether the earliestVehicleStartTime field is set.

      • getEarliestVehicleStartTime

        public 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;
        Specified by:
        getEarliestVehicleStartTime in interface OptimizeToursResponse.MetricsOrBuilder
        Returns:
        The earliestVehicleStartTime.

      • setEarliestVehicleStartTime

        public OptimizeToursResponse.Metrics.Builder setEarliestVehicleStartTime​(com.google.protobuf.Timestamp value)
         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;

      • setEarliestVehicleStartTime

        public OptimizeToursResponse.Metrics.Builder setEarliestVehicleStartTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         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;

      • mergeEarliestVehicleStartTime

        public OptimizeToursResponse.Metrics.Builder mergeEarliestVehicleStartTime​(com.google.protobuf.Timestamp value)
         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;

      • clearEarliestVehicleStartTime

        public OptimizeToursResponse.Metrics.Builder clearEarliestVehicleStartTime()
         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;

      • getEarliestVehicleStartTimeBuilder

        public com.google.protobuf.Timestamp.Builder getEarliestVehicleStartTimeBuilder()
         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;

      • getEarliestVehicleStartTimeOrBuilder

        public 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;
        Specified by:
        getEarliestVehicleStartTimeOrBuilder in interface OptimizeToursResponse.MetricsOrBuilder

      • hasLatestVehicleEndTime

        public 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;
        Specified by:
        hasLatestVehicleEndTime in interface OptimizeToursResponse.MetricsOrBuilder
        Returns:
        Whether the latestVehicleEndTime field is set.

      • getLatestVehicleEndTime

        public 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;
        Specified by:
        getLatestVehicleEndTime in interface OptimizeToursResponse.MetricsOrBuilder
        Returns:
        The latestVehicleEndTime.

      • setLatestVehicleEndTime

        public OptimizeToursResponse.Metrics.Builder setLatestVehicleEndTime​(com.google.protobuf.Timestamp value)
         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;

      • setLatestVehicleEndTime

        public OptimizeToursResponse.Metrics.Builder setLatestVehicleEndTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         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;

      • mergeLatestVehicleEndTime

        public OptimizeToursResponse.Metrics.Builder mergeLatestVehicleEndTime​(com.google.protobuf.Timestamp value)
         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;

      • clearLatestVehicleEndTime

        public OptimizeToursResponse.Metrics.Builder clearLatestVehicleEndTime()
         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;

      • getLatestVehicleEndTimeBuilder

        public com.google.protobuf.Timestamp.Builder getLatestVehicleEndTimeBuilder()
         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;

      • getLatestVehicleEndTimeOrBuilder

        public 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;
        Specified by:
        getLatestVehicleEndTimeOrBuilder in interface OptimizeToursResponse.MetricsOrBuilder

      • getCostsCount

        public int getCostsCount()
        Description copied from interface: OptimizeToursResponse.MetricsOrBuilder
         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;
        Specified by:
        getCostsCount in interface OptimizeToursResponse.MetricsOrBuilder

      • containsCosts

        public 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;
        Specified by:
        containsCosts in interface OptimizeToursResponse.MetricsOrBuilder

      • getCostsMap

        public 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;
        Specified by:
        getCostsMap in interface OptimizeToursResponse.MetricsOrBuilder

      • getCostsOrDefault

        public 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;
        Specified by:
        getCostsOrDefault in interface OptimizeToursResponse.MetricsOrBuilder

      • getCostsOrThrow

        public 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;
        Specified by:
        getCostsOrThrow in interface OptimizeToursResponse.MetricsOrBuilder

      • removeCosts

        public OptimizeToursResponse.Metrics.Builder removeCosts​(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;

      • getMutableCosts

        @Deprecated
public Map<String,​Double> getMutableCosts()
        Deprecated.
        Use alternate mutation accessors instead.

      • putCosts

        public OptimizeToursResponse.Metrics.Builder putCosts​(String key,
                                                      double value)
         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;

      • putAllCosts

        public OptimizeToursResponse.Metrics.Builder putAllCosts​(Map<String,​Double> values)
         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;

      • setTotalCost

        public OptimizeToursResponse.Metrics.Builder setTotalCost​(double value)
         Total cost of the solution. The sum of all values in the costs map.
        double total_cost = 6;
        Parameters:
        value - The totalCost to set.
        Returns:
        This builder for chaining.

      • clearTotalCost

        public OptimizeToursResponse.Metrics.Builder clearTotalCost()
         Total cost of the solution. The sum of all values in the costs map.
        double total_cost = 6;
        Returns:
        This builder for chaining.