Package com.google.cloud.optimization.v1

Interface ShipmentRouteOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ShipmentRoute, ShipmentRoute.Builder
    public interface ShipmentRouteOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getVehicleIndex

        int getVehicleIndex()
         Vehicle performing the route, identified by its index in the source
 `ShipmentModel`.
        int32 vehicle_index = 1;
        Returns:
        The vehicleIndex.

      • getVehicleLabel

        String getVehicleLabel()
         Label of the vehicle performing this route, equal to
 `ShipmentModel.vehicles(vehicle_index).label`, if specified.
        string vehicle_label = 2;
        Returns:
        The vehicleLabel.

      • getVehicleLabelBytes

        com.google.protobuf.ByteString getVehicleLabelBytes()
         Label of the vehicle performing this route, equal to
 `ShipmentModel.vehicles(vehicle_index).label`, if specified.
        string vehicle_label = 2;
        Returns:
        The bytes for vehicleLabel.

      • hasVehicleStartTime

        boolean hasVehicleStartTime()
         Time at which the vehicle starts its route.
        .google.protobuf.Timestamp vehicle_start_time = 5;
        Returns:
        Whether the vehicleStartTime field is set.

      • getVehicleStartTime

        com.google.protobuf.Timestamp getVehicleStartTime()
         Time at which the vehicle starts its route.
        .google.protobuf.Timestamp vehicle_start_time = 5;
        Returns:
        The vehicleStartTime.

      • getVehicleStartTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getVehicleStartTimeOrBuilder()
         Time at which the vehicle starts its route.
        .google.protobuf.Timestamp vehicle_start_time = 5;

      • hasVehicleEndTime

        boolean hasVehicleEndTime()
         Time at which the vehicle finishes its route.
        .google.protobuf.Timestamp vehicle_end_time = 6;
        Returns:
        Whether the vehicleEndTime field is set.

      • getVehicleEndTime

        com.google.protobuf.Timestamp getVehicleEndTime()
         Time at which the vehicle finishes its route.
        .google.protobuf.Timestamp vehicle_end_time = 6;
        Returns:
        The vehicleEndTime.

      • getVehicleEndTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getVehicleEndTimeOrBuilder()
         Time at which the vehicle finishes its route.
        .google.protobuf.Timestamp vehicle_end_time = 6;

      • getVisitsList

        List<ShipmentRoute.Visit> getVisitsList()
         Ordered sequence of visits representing a route.
 visits[i] is the i-th visit in the route.
 If this field is empty, the vehicle is considered as unused.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

      • getVisits

        ShipmentRoute.Visit getVisits​(int index)
         Ordered sequence of visits representing a route.
 visits[i] is the i-th visit in the route.
 If this field is empty, the vehicle is considered as unused.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

      • getVisitsCount

        int getVisitsCount()
         Ordered sequence of visits representing a route.
 visits[i] is the i-th visit in the route.
 If this field is empty, the vehicle is considered as unused.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

      • getVisitsOrBuilderList

        List<? extends ShipmentRoute.VisitOrBuilder> getVisitsOrBuilderList()
         Ordered sequence of visits representing a route.
 visits[i] is the i-th visit in the route.
 If this field is empty, the vehicle is considered as unused.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

      • getVisitsOrBuilder

        ShipmentRoute.VisitOrBuilder getVisitsOrBuilder​(int index)
         Ordered sequence of visits representing a route.
 visits[i] is the i-th visit in the route.
 If this field is empty, the vehicle is considered as unused.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

      • getTransitionsList

        List<ShipmentRoute.Transition> getTransitionsList()
         Ordered list of transitions for the route.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

      • getTransitions

        ShipmentRoute.Transition getTransitions​(int index)
         Ordered list of transitions for the route.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

      • getTransitionsCount

        int getTransitionsCount()
         Ordered list of transitions for the route.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

      • getTransitionsOrBuilderList

        List<? extends ShipmentRoute.TransitionOrBuilder> getTransitionsOrBuilderList()
         Ordered list of transitions for the route.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

      • getTransitionsOrBuilder

        ShipmentRoute.TransitionOrBuilder getTransitionsOrBuilder​(int index)
         Ordered list of transitions for the route.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

      • getHasTrafficInfeasibilities

        boolean getHasTrafficInfeasibilities()
         When
 [OptimizeToursRequest.consider_road_traffic][google.cloud.optimization.v1.OptimizeToursRequest.consider_road_traffic],
 is set to true, this field indicates that inconsistencies in route timings
 are predicted using traffic-based travel duration estimates. There may be
 insufficient time to complete traffic-adjusted travel, delays, and breaks
 between visits, before the first visit, or after the last visit, while
 still satisfying the visit and vehicle time windows. For example,

 ```
   start_time(previous_visit) + duration(previous_visit) +
   travel_duration(previous_visit, next_visit) > start_time(next_visit)
 ```

 Arrival at next_visit will likely happen later than its current
 time window due the increased estimate of travel time
 `travel_duration(previous_visit, next_visit)` due to traffic. Also, a break
 may be forced to overlap with a visit due to an increase in travel time
 estimates and visit or break time window restrictions.
        bool has_traffic_infeasibilities = 9;
        Returns:
        The hasTrafficInfeasibilities.

      • hasRoutePolyline

        boolean hasRoutePolyline()
         The encoded polyline representation of the route.
 This field is only populated if
 [OptimizeToursRequest.populate_polylines][google.cloud.optimization.v1.OptimizeToursRequest.populate_polylines]
 is set to true.
        .google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;
        Returns:
        Whether the routePolyline field is set.

      • getRoutePolyline

        ShipmentRoute.EncodedPolyline getRoutePolyline()
         The encoded polyline representation of the route.
 This field is only populated if
 [OptimizeToursRequest.populate_polylines][google.cloud.optimization.v1.OptimizeToursRequest.populate_polylines]
 is set to true.
        .google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;
        Returns:
        The routePolyline.

      • getRoutePolylineOrBuilder

        ShipmentRoute.EncodedPolylineOrBuilder getRoutePolylineOrBuilder()
         The encoded polyline representation of the route.
 This field is only populated if
 [OptimizeToursRequest.populate_polylines][google.cloud.optimization.v1.OptimizeToursRequest.populate_polylines]
 is set to true.
        .google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;

      • getBreaksList

        List<ShipmentRoute.Break> getBreaksList()
         Breaks scheduled for the vehicle performing this route.
 The `breaks` sequence represents time intervals, each starting at the
 corresponding `start_time` and lasting `duration` seconds.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

      • getBreaks

        ShipmentRoute.Break getBreaks​(int index)
         Breaks scheduled for the vehicle performing this route.
 The `breaks` sequence represents time intervals, each starting at the
 corresponding `start_time` and lasting `duration` seconds.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

      • getBreaksCount

        int getBreaksCount()
         Breaks scheduled for the vehicle performing this route.
 The `breaks` sequence represents time intervals, each starting at the
 corresponding `start_time` and lasting `duration` seconds.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

      • getBreaksOrBuilderList

        List<? extends ShipmentRoute.BreakOrBuilder> getBreaksOrBuilderList()
         Breaks scheduled for the vehicle performing this route.
 The `breaks` sequence represents time intervals, each starting at the
 corresponding `start_time` and lasting `duration` seconds.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

      • getBreaksOrBuilder

        ShipmentRoute.BreakOrBuilder getBreaksOrBuilder​(int index)
         Breaks scheduled for the vehicle performing this route.
 The `breaks` sequence represents time intervals, each starting at the
 corresponding `start_time` and lasting `duration` seconds.
        repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

      • hasMetrics

        boolean hasMetrics()
         Duration, distance and load metrics for this route. The fields of
 [AggregatedMetrics][google.cloud.optimization.v1.AggregatedMetrics] are
 summed over all
 [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
 or
 [ShipmentRoute.visits][google.cloud.optimization.v1.ShipmentRoute.visits],
 depending on the context.
        .google.cloud.optimization.v1.AggregatedMetrics metrics = 12;
        Returns:
        Whether the metrics field is set.

      • getMetrics

        AggregatedMetrics getMetrics()
         Duration, distance and load metrics for this route. The fields of
 [AggregatedMetrics][google.cloud.optimization.v1.AggregatedMetrics] are
 summed over all
 [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
 or
 [ShipmentRoute.visits][google.cloud.optimization.v1.ShipmentRoute.visits],
 depending on the context.
        .google.cloud.optimization.v1.AggregatedMetrics metrics = 12;
        Returns:
        The metrics.

      • getMetricsOrBuilder

        AggregatedMetricsOrBuilder getMetricsOrBuilder()
         Duration, distance and load metrics for this route. The fields of
 [AggregatedMetrics][google.cloud.optimization.v1.AggregatedMetrics] are
 summed over all
 [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
 or
 [ShipmentRoute.visits][google.cloud.optimization.v1.ShipmentRoute.visits],
 depending on the context.
        .google.cloud.optimization.v1.AggregatedMetrics metrics = 12;

      • getRouteCostsCount

        int getRouteCostsCount()
         Cost of the route, 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 route.
 In other words, costs["model.shipments.pickups.cost"] is the sum of all
 pickup costs over the route. 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> route_costs = 17;

      • containsRouteCosts

        boolean containsRouteCosts​(String key)
         Cost of the route, 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 route.
 In other words, costs["model.shipments.pickups.cost"] is the sum of all
 pickup costs over the route. 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> route_costs = 17;

      • getRouteCostsMap

        Map<String,​Double> getRouteCostsMap()
         Cost of the route, 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 route.
 In other words, costs["model.shipments.pickups.cost"] is the sum of all
 pickup costs over the route. 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> route_costs = 17;

      • getRouteCostsOrDefault

        double getRouteCostsOrDefault​(String key,
                              double defaultValue)
         Cost of the route, 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 route.
 In other words, costs["model.shipments.pickups.cost"] is the sum of all
 pickup costs over the route. 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> route_costs = 17;

      • getRouteCostsOrThrow

        double getRouteCostsOrThrow​(String key)
         Cost of the route, 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 route.
 In other words, costs["model.shipments.pickups.cost"] is the sum of all
 pickup costs over the route. 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> route_costs = 17;

      • getRouteTotalCost

        double getRouteTotalCost()
         Total cost of the route. The sum of all costs in the cost map.
        double route_total_cost = 18;
        Returns:
        The routeTotalCost.

      • getEndLoadsList

        @Deprecated
List<CapacityQuantity> getEndLoadsList()
        Deprecated.
         Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead. Vehicle loads upon arrival at its end location, for each type
 specified in
 [Vehicle.capacities][google.cloud.optimization.v1.Vehicle.capacities],
 `start_load_intervals`, `end_load_intervals` or demands. Exception: we omit
 loads for quantity types unconstrained by intervals and that don't have any
 non-zero demand on the route.
        repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

      • getEndLoads

        @Deprecated
CapacityQuantity getEndLoads​(int index)
        Deprecated.
         Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead. Vehicle loads upon arrival at its end location, for each type
 specified in
 [Vehicle.capacities][google.cloud.optimization.v1.Vehicle.capacities],
 `start_load_intervals`, `end_load_intervals` or demands. Exception: we omit
 loads for quantity types unconstrained by intervals and that don't have any
 non-zero demand on the route.
        repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

      • getEndLoadsCount

        @Deprecated
int getEndLoadsCount()
        Deprecated.
         Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead. Vehicle loads upon arrival at its end location, for each type
 specified in
 [Vehicle.capacities][google.cloud.optimization.v1.Vehicle.capacities],
 `start_load_intervals`, `end_load_intervals` or demands. Exception: we omit
 loads for quantity types unconstrained by intervals and that don't have any
 non-zero demand on the route.
        repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

      • getEndLoadsOrBuilderList

        @Deprecated
List<? extends CapacityQuantityOrBuilder> getEndLoadsOrBuilderList()
        Deprecated.
         Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead. Vehicle loads upon arrival at its end location, for each type
 specified in
 [Vehicle.capacities][google.cloud.optimization.v1.Vehicle.capacities],
 `start_load_intervals`, `end_load_intervals` or demands. Exception: we omit
 loads for quantity types unconstrained by intervals and that don't have any
 non-zero demand on the route.
        repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

      • getEndLoadsOrBuilder

        @Deprecated
CapacityQuantityOrBuilder getEndLoadsOrBuilder​(int index)
        Deprecated.
         Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead. Vehicle loads upon arrival at its end location, for each type
 specified in
 [Vehicle.capacities][google.cloud.optimization.v1.Vehicle.capacities],
 `start_load_intervals`, `end_load_intervals` or demands. Exception: we omit
 loads for quantity types unconstrained by intervals and that don't have any
 non-zero demand on the route.
        repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

      • getTravelStepsList

        @Deprecated
List<ShipmentRoute.TravelStep> getTravelStepsList()
        Deprecated.
         Deprecated: Use
 [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
 instead. Ordered list of travel steps for the route.
        repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

      • getTravelSteps

        @Deprecated
ShipmentRoute.TravelStep getTravelSteps​(int index)
        Deprecated.
         Deprecated: Use
 [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
 instead. Ordered list of travel steps for the route.
        repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

      • getTravelStepsCount

        @Deprecated
int getTravelStepsCount()
        Deprecated.
         Deprecated: Use
 [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
 instead. Ordered list of travel steps for the route.
        repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

      • getTravelStepsOrBuilderList

        @Deprecated
List<? extends ShipmentRoute.TravelStepOrBuilder> getTravelStepsOrBuilderList()
        Deprecated.
         Deprecated: Use
 [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
 instead. Ordered list of travel steps for the route.
        repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

      • getTravelStepsOrBuilder

        @Deprecated
ShipmentRoute.TravelStepOrBuilder getTravelStepsOrBuilder​(int index)
        Deprecated.
         Deprecated: Use
 [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
 instead. Ordered list of travel steps for the route.
        repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

      • hasVehicleDetour

        @Deprecated
boolean hasVehicleDetour()
        Deprecated.
        google.cloud.optimization.v1.ShipmentRoute.vehicle_detour is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=2185
         Deprecated: No longer used.
 This field will only be populated at the
 [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit]
 level.

 This field is the extra detour time due to the shipments visited on the
 route.

 It is equal to `vehicle_end_time` - `vehicle_start_time` - travel duration
 from the vehicle's start_location to its `end_location`.
        .google.protobuf.Duration vehicle_detour = 15 [deprecated = true];
        Returns:
        Whether the vehicleDetour field is set.

      • getVehicleDetour

        @Deprecated
com.google.protobuf.Duration getVehicleDetour()
        Deprecated.
        google.cloud.optimization.v1.ShipmentRoute.vehicle_detour is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=2185
         Deprecated: No longer used.
 This field will only be populated at the
 [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit]
 level.

 This field is the extra detour time due to the shipments visited on the
 route.

 It is equal to `vehicle_end_time` - `vehicle_start_time` - travel duration
 from the vehicle's start_location to its `end_location`.
        .google.protobuf.Duration vehicle_detour = 15 [deprecated = true];
        Returns:
        The vehicleDetour.

      • getVehicleDetourOrBuilder

        @Deprecated
com.google.protobuf.DurationOrBuilder getVehicleDetourOrBuilder()
        Deprecated.
         Deprecated: No longer used.
 This field will only be populated at the
 [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit]
 level.

 This field is the extra detour time due to the shipments visited on the
 route.

 It is equal to `vehicle_end_time` - `vehicle_start_time` - travel duration
 from the vehicle's start_location to its `end_location`.
        .google.protobuf.Duration vehicle_detour = 15 [deprecated = true];

      • hasDelayBeforeVehicleEnd

        @Deprecated
boolean hasDelayBeforeVehicleEnd()
        Deprecated.
        google.cloud.optimization.v1.ShipmentRoute.delay_before_vehicle_end is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=2189
         Deprecated: Delay occurring before the vehicle end. See
 [TransitionAttributes.delay][google.cloud.optimization.v1.TransitionAttributes.delay].
        .google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];
        Returns:
        Whether the delayBeforeVehicleEnd field is set.

      • getDelayBeforeVehicleEnd

        @Deprecated
ShipmentRoute.Delay getDelayBeforeVehicleEnd()
        Deprecated.
        google.cloud.optimization.v1.ShipmentRoute.delay_before_vehicle_end is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=2189
         Deprecated: Delay occurring before the vehicle end. See
 [TransitionAttributes.delay][google.cloud.optimization.v1.TransitionAttributes.delay].
        .google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];
        Returns:
        The delayBeforeVehicleEnd.

      • getDelayBeforeVehicleEndOrBuilder

        @Deprecated
ShipmentRoute.DelayOrBuilder getDelayBeforeVehicleEndOrBuilder()
        Deprecated.
         Deprecated: Delay occurring before the vehicle end. See
 [TransitionAttributes.delay][google.cloud.optimization.v1.TransitionAttributes.delay].
        .google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];