Interface ShipmentRouteOrBuilder (0.1.2)
Stay organized with collections
Save and categorize content based on your preferences.
- 1.76.0 (latest)
- 1.74.0
- 1.73.0
- 1.72.0
- 1.71.0
- 1.70.0
- 1.68.0
- 1.66.0
- 1.65.0
- 1.62.0
- 1.61.0
- 1.60.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.14
- 0.1.2
publicinterface ShipmentRouteOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsRouteCosts(String key)
publicabstractbooleancontainsRouteCosts(Stringkey)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;
getBreaks(int index)
publicabstractShipmentRoute.BreakgetBreaks(intindex) 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()
publicabstractintgetBreaksCount() 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;
getBreaksList()
publicabstractList<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;
getBreaksOrBuilder(int index)
publicabstractShipmentRoute.BreakOrBuildergetBreaksOrBuilder(intindex) 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()
publicabstractList<?extendsShipmentRoute.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;
getDelayBeforeVehicleEnd()
publicabstractShipmentRoute.DelaygetDelayBeforeVehicleEnd()Deprecated: Use [ShipmentRoute.Transition.delay_duration][] instead. Delay occurring before the vehicle end. See TransitionAttributes.delay.
.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];
The delayBeforeVehicleEnd.
getDelayBeforeVehicleEndOrBuilder()
publicabstractShipmentRoute.DelayOrBuildergetDelayBeforeVehicleEndOrBuilder()Deprecated: Use [ShipmentRoute.Transition.delay_duration][] instead. Delay occurring before the vehicle end. See TransitionAttributes.delay.
.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];
getEndLoads(int index)
publicabstractCapacityQuantitygetEndLoads(intindex) Deprecated: Use [ShipmentRoute.Transition.loads][] instead.
Vehicle loads upon arrival at its end location, for each
type specified in 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()
publicabstractintgetEndLoadsCount() Deprecated: Use [ShipmentRoute.Transition.loads][] instead.
Vehicle loads upon arrival at its end location, for each
type specified in 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];
getEndLoadsList()
publicabstractList<CapacityQuantity>getEndLoadsList() Deprecated: Use [ShipmentRoute.Transition.loads][] instead.
Vehicle loads upon arrival at its end location, for each
type specified in 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(int index)
publicabstractCapacityQuantityOrBuildergetEndLoadsOrBuilder(intindex) Deprecated: Use [ShipmentRoute.Transition.loads][] instead.
Vehicle loads upon arrival at its end location, for each
type specified in 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()
publicabstractList<?extendsCapacityQuantityOrBuilder>getEndLoadsOrBuilderList() Deprecated: Use [ShipmentRoute.Transition.loads][] instead.
Vehicle loads upon arrival at its end location, for each
type specified in 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];
getHasTrafficInfeasibilities()
publicabstractbooleangetHasTrafficInfeasibilities() When
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,
<code><code>start_time(previous_visit) + duration(previous_visit) +
travel_duration(previous_visit, next_visit) > start_time(next_visit)</code></code><code>
Arrival at next_visit will likely happen later than its current
time window due the increased estimate of travel time
</code>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;
The hasTrafficInfeasibilities.
getMetrics()
publicabstractAggregatedMetricsgetMetrics()Duration, distance and load metrics for this route. The fields of AggregatedMetrics are summed over all ShipmentRoute.transitions or ShipmentRoute.visits, depending on the context.
.google.cloud.optimization.v1.AggregatedMetrics metrics = 12;
The metrics.
getMetricsOrBuilder()
publicabstractAggregatedMetricsOrBuildergetMetricsOrBuilder()Duration, distance and load metrics for this route. The fields of AggregatedMetrics are summed over all ShipmentRoute.transitions or ShipmentRoute.visits, depending on the context.
.google.cloud.optimization.v1.AggregatedMetrics metrics = 12;
getRouteCosts()
publicabstractMap<String,Double>getRouteCosts()Use #getRouteCostsMap() instead.
getRouteCostsCount()
publicabstractintgetRouteCostsCount()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()
publicabstractMap<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(String key, double defaultValue)
publicabstractdoublegetRouteCostsOrDefault(Stringkey,doubledefaultValue)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(String key)
publicabstractdoublegetRouteCostsOrThrow(Stringkey)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;
getRoutePolyline()
publicabstractShipmentRoute.EncodedPolylinegetRoutePolyline()The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true.
.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;
The routePolyline.
getRoutePolylineOrBuilder()
publicabstractShipmentRoute.EncodedPolylineOrBuildergetRoutePolylineOrBuilder()The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true.
.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;
getRouteTotalCost()
publicabstractdoublegetRouteTotalCost()Total cost of the route. The sum of all costs in the cost map.
double route_total_cost = 18;
The routeTotalCost.
getTransitions(int index)
publicabstractShipmentRoute.TransitiongetTransitions(intindex)Ordered list of transitions for the route.
repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
getTransitionsCount()
publicabstractintgetTransitionsCount()Ordered list of transitions for the route.
repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
getTransitionsList()
publicabstractList<ShipmentRoute.Transition>getTransitionsList()Ordered list of transitions for the route.
repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
getTransitionsOrBuilder(int index)
publicabstractShipmentRoute.TransitionOrBuildergetTransitionsOrBuilder(intindex)Ordered list of transitions for the route.
repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
getTransitionsOrBuilderList()
publicabstractList<?extendsShipmentRoute.TransitionOrBuilder>getTransitionsOrBuilderList()Ordered list of transitions for the route.
repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
getTravelSteps(int index)
publicabstractShipmentRoute.TravelStepgetTravelSteps(intindex)Deprecated: Use [ShipmentRoute.Transition][] instead. Ordered list of travel steps for the route.
repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
getTravelStepsCount()
publicabstractintgetTravelStepsCount()Deprecated: Use [ShipmentRoute.Transition][] instead. Ordered list of travel steps for the route.
repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
getTravelStepsList()
publicabstractList<ShipmentRoute.TravelStep>getTravelStepsList()Deprecated: Use [ShipmentRoute.Transition][] instead. Ordered list of travel steps for the route.
repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
getTravelStepsOrBuilder(int index)
publicabstractShipmentRoute.TravelStepOrBuildergetTravelStepsOrBuilder(intindex)Deprecated: Use [ShipmentRoute.Transition][] instead. Ordered list of travel steps for the route.
repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
getTravelStepsOrBuilderList()
publicabstractList<?extendsShipmentRoute.TravelStepOrBuilder>getTravelStepsOrBuilderList()Deprecated: Use [ShipmentRoute.Transition][] instead. Ordered list of travel steps for the route.
repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
getVehicleDetour()
publicabstractDurationgetVehicleDetour() Deprecated: No longer used.
This field will only be populated at the
ShipmentRoute.Visit level.
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];
The vehicleDetour.
getVehicleDetourOrBuilder()
publicabstractDurationOrBuildergetVehicleDetourOrBuilder() Deprecated: No longer used.
This field will only be populated at the
ShipmentRoute.Visit level.
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];
getVehicleEndTime()
publicabstractTimestampgetVehicleEndTime()Time at which the vehicle finishes its route.
.google.protobuf.Timestamp vehicle_end_time = 6;
The vehicleEndTime.
getVehicleEndTimeOrBuilder()
publicabstractTimestampOrBuildergetVehicleEndTimeOrBuilder()Time at which the vehicle finishes its route.
.google.protobuf.Timestamp vehicle_end_time = 6;
getVehicleIndex()
publicabstractintgetVehicleIndex() Vehicle performing the route, identified by its index in the source
ShipmentModel.
int32 vehicle_index = 1;
The vehicleIndex.
getVehicleLabel()
publicabstractStringgetVehicleLabel() Label of the vehicle performing this route, equal to
ShipmentModel.vehicles(vehicle_index).label, if specified.
string vehicle_label = 2;
The vehicleLabel.
getVehicleLabelBytes()
publicabstractByteStringgetVehicleLabelBytes() Label of the vehicle performing this route, equal to
ShipmentModel.vehicles(vehicle_index).label, if specified.
string vehicle_label = 2;
The bytes for vehicleLabel.
getVehicleStartTime()
publicabstractTimestampgetVehicleStartTime()Time at which the vehicle starts its route.
.google.protobuf.Timestamp vehicle_start_time = 5;
The vehicleStartTime.
getVehicleStartTimeOrBuilder()
publicabstractTimestampOrBuildergetVehicleStartTimeOrBuilder()Time at which the vehicle starts its route.
.google.protobuf.Timestamp vehicle_start_time = 5;
getVisits(int index)
publicabstractShipmentRoute.VisitgetVisits(intindex)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()
publicabstractintgetVisitsCount()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;
getVisitsList()
publicabstractList<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;
getVisitsOrBuilder(int index)
publicabstractShipmentRoute.VisitOrBuildergetVisitsOrBuilder(intindex)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()
publicabstractList<?extendsShipmentRoute.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;
hasDelayBeforeVehicleEnd()
publicabstractbooleanhasDelayBeforeVehicleEnd()Deprecated: Use [ShipmentRoute.Transition.delay_duration][] instead. Delay occurring before the vehicle end. See TransitionAttributes.delay.
.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];
Whether the delayBeforeVehicleEnd field is set.
hasMetrics()
publicabstractbooleanhasMetrics()Duration, distance and load metrics for this route. The fields of AggregatedMetrics are summed over all ShipmentRoute.transitions or ShipmentRoute.visits, depending on the context.
.google.cloud.optimization.v1.AggregatedMetrics metrics = 12;
Whether the metrics field is set.
hasRoutePolyline()
publicabstractbooleanhasRoutePolyline()The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true.
.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;
Whether the routePolyline field is set.
hasVehicleDetour()
publicabstractbooleanhasVehicleDetour() Deprecated: No longer used.
This field will only be populated at the
ShipmentRoute.Visit level.
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];
Whether the vehicleDetour field is set.
hasVehicleEndTime()
publicabstractbooleanhasVehicleEndTime()Time at which the vehicle finishes its route.
.google.protobuf.Timestamp vehicle_end_time = 6;
Whether the vehicleEndTime field is set.
hasVehicleStartTime()
publicabstractbooleanhasVehicleStartTime()Time at which the vehicle starts its route.
.google.protobuf.Timestamp vehicle_start_time = 5;
Whether the vehicleStartTime field is set.