Interface ShipmentRouteOrBuilder (1.28.0)

Version 1.28.0

• 1.53.0 (latest)
• 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

public interface ShipmentRouteOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsRouteCosts(String key)

public abstract 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;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getBreaks(int index)

public abstract 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;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentRoute.Break

getBreaksCount()

public abstract 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;

Returns
Type	Description
int

getBreaksList()

public abstract 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;

Returns
Type	Description
List<Break>

getBreaksOrBuilder(int index)

public abstract 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;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentRoute.BreakOrBuilder

getBreaksOrBuilderList()

public abstract 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;

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.ShipmentRoute.BreakOrBuilder>

getDelayBeforeVehicleEnd() (deprecated)

public abstract ShipmentRoute.Delay getDelayBeforeVehicleEnd()

Deprecated. google.cloud.optimization.v1.ShipmentRoute.delay_before_vehicle_end is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=2219

Deprecated: Delay occurring before the vehicle end. See TransitionAttributes.delay.

.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];

Returns
Type	Description
ShipmentRoute.Delay	The delayBeforeVehicleEnd.

getDelayBeforeVehicleEndOrBuilder()

public abstract ShipmentRoute.DelayOrBuilder getDelayBeforeVehicleEndOrBuilder()

Deprecated: Delay occurring before the vehicle end. See TransitionAttributes.delay.

.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];

Returns
Type	Description
ShipmentRoute.DelayOrBuilder

getEndLoads(int index)

public abstract CapacityQuantity getEndLoads(int index)

Deprecated: Use Transition.vehicle_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];

Parameter
Name	Description
index	int

Returns
Type	Description
CapacityQuantity

getEndLoadsCount()

public abstract int getEndLoadsCount()

Deprecated: Use Transition.vehicle_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];

Returns
Type	Description
int

getEndLoadsList()

public abstract List<CapacityQuantity> getEndLoadsList()

Deprecated: Use Transition.vehicle_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];

Returns
Type	Description
List<CapacityQuantity>

getEndLoadsOrBuilder(int index)

public abstract CapacityQuantityOrBuilder getEndLoadsOrBuilder(int index)

Deprecated: Use Transition.vehicle_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];

Parameter
Name	Description
index	int

Returns
Type	Description
CapacityQuantityOrBuilder

getEndLoadsOrBuilderList()

public abstract List<? extends CapacityQuantityOrBuilder> getEndLoadsOrBuilderList()

Deprecated: Use Transition.vehicle_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];

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.CapacityQuantityOrBuilder>

getHasTrafficInfeasibilities()

public abstract boolean getHasTrafficInfeasibilities()

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,

` 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
Type	Description
boolean	The hasTrafficInfeasibilities.

getMetrics()

public abstract AggregatedMetrics getMetrics()

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;

Returns
Type	Description
AggregatedMetrics	The metrics.

getMetricsOrBuilder()

public abstract AggregatedMetricsOrBuilder getMetricsOrBuilder()

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;

Returns
Type	Description
AggregatedMetricsOrBuilder

getRouteCosts()

public abstract Map<String,Double> getRouteCosts()

Use #getRouteCostsMap() instead.

Returns
Type	Description
Map<String,Double>

getRouteCostsCount()

public abstract 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;

Returns
Type	Description
int

getRouteCostsMap()

public abstract 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;

Returns
Type	Description
Map<String,Double>

getRouteCostsOrDefault(String key, double defaultValue)

public abstract 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;

Parameters
Name	Description
key	String
defaultValue	double

Returns
Type	Description
double

getRouteCostsOrThrow(String key)

public abstract 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;

Parameter
Name	Description
key	String

Returns
Type	Description
double

getRoutePolyline()

public abstract ShipmentRoute.EncodedPolyline getRoutePolyline()

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;

Returns
Type	Description
ShipmentRoute.EncodedPolyline	The routePolyline.

getRoutePolylineOrBuilder()

public abstract ShipmentRoute.EncodedPolylineOrBuilder getRoutePolylineOrBuilder()

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;

Returns
Type	Description
ShipmentRoute.EncodedPolylineOrBuilder

getRouteTotalCost()

public abstract double getRouteTotalCost()

Total cost of the route. The sum of all costs in the cost map.

double route_total_cost = 18;

Returns
Type	Description
double	The routeTotalCost.

getTransitions(int index)

public abstract ShipmentRoute.Transition getTransitions(int index)

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentRoute.Transition

getTransitionsCount()

public abstract int getTransitionsCount()

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Returns
Type	Description
int

getTransitionsList()

public abstract List<ShipmentRoute.Transition> getTransitionsList()

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Returns
Type	Description
List<Transition>

getTransitionsOrBuilder(int index)

public abstract ShipmentRoute.TransitionOrBuilder getTransitionsOrBuilder(int index)

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentRoute.TransitionOrBuilder

getTransitionsOrBuilderList()

public abstract List<? extends ShipmentRoute.TransitionOrBuilder> getTransitionsOrBuilderList()

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.ShipmentRoute.TransitionOrBuilder>

getTravelSteps(int index)

public abstract ShipmentRoute.TravelStep getTravelSteps(int index)

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentRoute.TravelStep

getTravelStepsCount()

public abstract int getTravelStepsCount()

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Returns
Type	Description
int

getTravelStepsList()

public abstract List<ShipmentRoute.TravelStep> getTravelStepsList()

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Returns
Type	Description
List<TravelStep>

getTravelStepsOrBuilder(int index)

public abstract ShipmentRoute.TravelStepOrBuilder getTravelStepsOrBuilder(int index)

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentRoute.TravelStepOrBuilder

getTravelStepsOrBuilderList()

public abstract List<? extends ShipmentRoute.TravelStepOrBuilder> getTravelStepsOrBuilderList()

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.ShipmentRoute.TravelStepOrBuilder>

getVehicleDetour() (deprecated)

public abstract Duration getVehicleDetour()

Deprecated. google.cloud.optimization.v1.ShipmentRoute.vehicle_detour is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=2215

Deprecated: No longer used. This field will only be populated at the 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
Type	Description
Duration	The vehicleDetour.

getVehicleDetourOrBuilder()

public abstract DurationOrBuilder getVehicleDetourOrBuilder()

Deprecated: No longer used. This field will only be populated at the 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
Type	Description
DurationOrBuilder

getVehicleEndTime()

public abstract Timestamp getVehicleEndTime()

Time at which the vehicle finishes its route.

.google.protobuf.Timestamp vehicle_end_time = 6;

Returns
Type	Description
Timestamp	The vehicleEndTime.

getVehicleEndTimeOrBuilder()

public abstract TimestampOrBuilder getVehicleEndTimeOrBuilder()

Time at which the vehicle finishes its route.

.google.protobuf.Timestamp vehicle_end_time = 6;

Returns
Type	Description
TimestampOrBuilder

getVehicleIndex()

public abstract int getVehicleIndex()

Vehicle performing the route, identified by its index in the source ShipmentModel.

int32 vehicle_index = 1;

Returns
Type	Description
int	The vehicleIndex.

getVehicleLabel()

public abstract String getVehicleLabel()

Label of the vehicle performing this route, equal to ShipmentModel.vehicles(vehicle_index).label, if specified.

string vehicle_label = 2;

Returns
Type	Description
String	The vehicleLabel.

getVehicleLabelBytes()

public abstract ByteString getVehicleLabelBytes()

Label of the vehicle performing this route, equal to ShipmentModel.vehicles(vehicle_index).label, if specified.

string vehicle_label = 2;

Returns
Type	Description
ByteString	The bytes for vehicleLabel.

getVehicleStartTime()

public abstract Timestamp getVehicleStartTime()

Time at which the vehicle starts its route.

.google.protobuf.Timestamp vehicle_start_time = 5;

Returns
Type	Description
Timestamp	The vehicleStartTime.

getVehicleStartTimeOrBuilder()

public abstract TimestampOrBuilder getVehicleStartTimeOrBuilder()

Time at which the vehicle starts its route.

.google.protobuf.Timestamp vehicle_start_time = 5;

Returns
Type	Description
TimestampOrBuilder

getVisits(int index)

public abstract 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;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentRoute.Visit

getVisitsCount()

public abstract 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;

Returns
Type	Description
int

getVisitsList()

public abstract 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;

Returns
Type	Description
List<Visit>

getVisitsOrBuilder(int index)

public abstract 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;

Parameter
Name	Description
index	int

Returns
Type	Description
ShipmentRoute.VisitOrBuilder

getVisitsOrBuilderList()

public abstract 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;

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.ShipmentRoute.VisitOrBuilder>

hasDelayBeforeVehicleEnd() (deprecated)

public abstract boolean hasDelayBeforeVehicleEnd()

Deprecated. google.cloud.optimization.v1.ShipmentRoute.delay_before_vehicle_end is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=2219

Deprecated: Delay occurring before the vehicle end. See TransitionAttributes.delay.

.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];

Returns
Type	Description
boolean	Whether the delayBeforeVehicleEnd field is set.

hasMetrics()

public abstract boolean hasMetrics()

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;

Returns
Type	Description
boolean	Whether the metrics field is set.

hasRoutePolyline()

public abstract boolean hasRoutePolyline()

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;

Returns
Type	Description
boolean	Whether the routePolyline field is set.

hasVehicleDetour() (deprecated)

public abstract boolean hasVehicleDetour()

Deprecated. google.cloud.optimization.v1.ShipmentRoute.vehicle_detour is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=2215

Deprecated: No longer used. This field will only be populated at the 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
Type	Description
boolean	Whether the vehicleDetour field is set.

hasVehicleEndTime()

public abstract boolean hasVehicleEndTime()

Time at which the vehicle finishes its route.

.google.protobuf.Timestamp vehicle_end_time = 6;

Returns
Type	Description
boolean	Whether the vehicleEndTime field is set.

hasVehicleStartTime()

public abstract boolean hasVehicleStartTime()

Time at which the vehicle starts its route.

.google.protobuf.Timestamp vehicle_start_time = 5;

Returns
Type	Description
boolean	Whether the vehicleStartTime field is set.