Class ShipmentRoute (1.43.0)
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
publicfinalclass ShipmentRouteextendsGeneratedMessageV3implementsShipmentRouteOrBuilder A vehicle's route can be decomposed, along the time axis, like this (we
assume there are n visits):
`
| | | | | T[2], | | |
| Transition | Visit #0 | | | V[2], | | |
| #0 | aka | T[1] | V[1] | ... | V[n-1] | T[n] |
| aka T[0] | V[0] | | | V[n-2],| | |
| | | | | T[n-1] | | |
^ ^ ^ ^ ^ ^ ^ ^
vehicle V[0].start V[0].end V[1]. V[1]. V[n]. V[n]. vehicle
start (arrival) (departure) start end start end end
Note that we make a difference between:
- "punctual events", such as the vehicle start and end and each visit's start and end (aka arrival and departure). They happen at a given second.
"time intervals", such as the visits themselves, and the transition between visits. Though time intervals can sometimes have zero duration, i.e. start and end at the same second, they often have a positive duration.
Invariants:
If there are n visits, there are n+1 transitions.
- A visit is always surrounded by a transition before it (same index) and a transition after it (index + 1).
- The vehicle start is always followed by transition #0.
The vehicle end is always preceded by transition #n.
Zooming in, here is what happens during a
and a Visit:
---+-------------------------------------+-----------------------------+-->
| TRANSITION[i] | VISIT[i] |
| | |
| * TRAVEL: the vehicle moves from | PERFORM the visit: |
| VISIT[i-1].departure_location to | |
| VISIT[i].arrival_location, which | * Spend some time: |
| takes a given travel duration | the "visit duration". |
| and distance | |
| | * Load or unload |
| * BREAKS: the driver may have | some quantities from the |
| breaks (e.g. lunch break). | vehicle: the "demand". |
| | |
| * WAIT: the driver/vehicle does | |
| nothing. This can happen for | |
| many reasons, for example when | |
| the vehicle reaches the next | |
| event's destination before the | |
| start of its time window | |
| | |
| * DELAY: right before the next | |
| arrival. E.g. the vehicle and/or | |
| driver spends time unloading. | |
| | |
---+-------------------------------------+-----------------------------+-->
^ ^ ^
V[i-1].end V[i].start V[i].end
Lastly, here is how the TRAVEL, BREAKS, DELAY and WAIT can be arranged
during a transition.They don't overlap.
The DELAY is unique and must be a contiguous period of time right
before the next visit (or vehicle end). Thus, it suffice to know the
delay duration to know its start and end time.
The BREAKS are contiguous, non-overlapping periods of time. The
response specifies the start time and duration of each break.
TRAVEL and WAIT are "preemptable": they can be interrupted several times
during this transition. Clients can assume that travel happens "as soon as
possible" and that "wait" fills the remaining time.
A (complex) example:
TRANSITION[i]
--++-----+-----------------------------------------------------------++-->
|| | | | | | | ||
|| T | B | T | | B | | D ||
|| r | r | r | W | r | W | e ||
|| a | e | a | a | e | a | l ||
|| v | a | v | i | a | i | a ||
|| e | k | e | t | k | t | y ||
|| l | | l | | | | ||
|| | | | | | | ||
--++-----------------------------------------------------------------++-->
Protobuf type google.cloud.optimization.v1.ShipmentRoute
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ShipmentRouteImplements
ShipmentRouteOrBuilderInherited Members
Static Fields
BREAKS_FIELD_NUMBER
publicstaticfinalintBREAKS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DELAY_BEFORE_VEHICLE_END_FIELD_NUMBER
publicstaticfinalintDELAY_BEFORE_VEHICLE_END_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
END_LOADS_FIELD_NUMBER
publicstaticfinalintEND_LOADS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
HAS_TRAFFIC_INFEASIBILITIES_FIELD_NUMBER
publicstaticfinalintHAS_TRAFFIC_INFEASIBILITIES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
METRICS_FIELD_NUMBER
publicstaticfinalintMETRICS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ROUTE_COSTS_FIELD_NUMBER
publicstaticfinalintROUTE_COSTS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ROUTE_POLYLINE_FIELD_NUMBER
publicstaticfinalintROUTE_POLYLINE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ROUTE_TOTAL_COST_FIELD_NUMBER
publicstaticfinalintROUTE_TOTAL_COST_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TRANSITIONS_FIELD_NUMBER
publicstaticfinalintTRANSITIONS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TRAVEL_STEPS_FIELD_NUMBER
publicstaticfinalintTRAVEL_STEPS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
VEHICLE_DETOUR_FIELD_NUMBER
publicstaticfinalintVEHICLE_DETOUR_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
VEHICLE_END_TIME_FIELD_NUMBER
publicstaticfinalintVEHICLE_END_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
VEHICLE_INDEX_FIELD_NUMBER
publicstaticfinalintVEHICLE_INDEX_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
VEHICLE_LABEL_FIELD_NUMBER
publicstaticfinalintVEHICLE_LABEL_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
VEHICLE_START_TIME_FIELD_NUMBER
publicstaticfinalintVEHICLE_START_TIME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
VISITS_FIELD_NUMBER
publicstaticfinalintVISITS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
publicstaticShipmentRoutegetDefaultInstance()| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
|
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
publicstaticShipmentRoute.BuildernewBuilder()| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.Builder |
|
newBuilder(ShipmentRoute prototype)
publicstaticShipmentRoute.BuildernewBuilder(ShipmentRouteprototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
ShipmentRoute |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.Builder |
|
parseDelimitedFrom(InputStream input)
publicstaticShipmentRouteparseDelimitedFrom(InputStreaminput)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticShipmentRouteparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
publicstaticShipmentRouteparseFrom(byte[]data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticShipmentRouteparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
publicstaticShipmentRouteparseFrom(ByteStringdata)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticShipmentRouteparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
publicstaticShipmentRouteparseFrom(CodedInputStreaminput)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticShipmentRouteparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
publicstaticShipmentRouteparseFrom(InputStreaminput)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticShipmentRouteparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
publicstaticShipmentRouteparseFrom(ByteBufferdata)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticShipmentRouteparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
publicstaticParser<ShipmentRoute>parser()| Returns | |
|---|---|
| Type | Description |
Parser<ShipmentRoute> |
|
Methods
containsRouteCosts(String key)
publicbooleancontainsRouteCosts(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;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
equals(Object obj)
publicbooleanequals(Objectobj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getBreaks(int index)
publicShipmentRoute.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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.Break |
|
getBreaksCount()
publicintgetBreaksCount() 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()
publicList<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)
publicShipmentRoute.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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.BreakOrBuilder |
|
getBreaksOrBuilderList()
publicList<?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;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.optimization.v1.ShipmentRoute.BreakOrBuilder> |
|
getDefaultInstanceForType()
publicShipmentRoutegetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ShipmentRoute |
|
getDelayBeforeVehicleEnd() (deprecated)
publicShipmentRoute.DelaygetDelayBeforeVehicleEnd()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() (deprecated)
publicShipmentRoute.DelayOrBuildergetDelayBeforeVehicleEndOrBuilder()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) (deprecated)
publicCapacityQuantitygetEndLoads(intindex) 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() (deprecated)
publicintgetEndLoadsCount() 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() (deprecated)
publicList<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) (deprecated)
publicCapacityQuantityOrBuildergetEndLoadsOrBuilder(intindex) 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() (deprecated)
publicList<?extendsCapacityQuantityOrBuilder>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()
publicbooleangetHasTrafficInfeasibilities()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()
publicAggregatedMetricsgetMetrics()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()
publicAggregatedMetricsOrBuildergetMetricsOrBuilder()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 |
|
getParserForType()
publicParser<ShipmentRoute>getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<ShipmentRoute> |
|
getRouteCosts() (deprecated)
publicMap<String,Double>getRouteCosts()Use #getRouteCostsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Double> |
|
getRouteCostsCount()
publicintgetRouteCostsCount()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()
publicMap<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)
publicdoublegetRouteCostsOrDefault(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;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
double |
| Returns | |
|---|---|
| Type | Description |
double |
|
getRouteCostsOrThrow(String key)
publicdoublegetRouteCostsOrThrow(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;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
double |
|
getRoutePolyline()
publicShipmentRoute.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;
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.EncodedPolyline |
The routePolyline. |
getRoutePolylineOrBuilder()
publicShipmentRoute.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;
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.EncodedPolylineOrBuilder |
|
getRouteTotalCost()
publicdoublegetRouteTotalCost()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. |
getSerializedSize()
publicintgetSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getTransitions(int index)
publicShipmentRoute.TransitiongetTransitions(intindex)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()
publicintgetTransitionsCount()Ordered list of transitions for the route.
repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
| Returns | |
|---|---|
| Type | Description |
int |
|
getTransitionsList()
publicList<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)
publicShipmentRoute.TransitionOrBuildergetTransitionsOrBuilder(intindex)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()
publicList<?extendsShipmentRoute.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) (deprecated)
publicShipmentRoute.TravelStepgetTravelSteps(intindex)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() (deprecated)
publicintgetTravelStepsCount()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() (deprecated)
publicList<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) (deprecated)
publicShipmentRoute.TravelStepOrBuildergetTravelStepsOrBuilder(intindex)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() (deprecated)
publicList<?extendsShipmentRoute.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)
publicDurationgetVehicleDetour()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() (deprecated)
publicDurationOrBuildergetVehicleDetourOrBuilder()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()
publicTimestampgetVehicleEndTime()Time at which the vehicle finishes its route.
.google.protobuf.Timestamp vehicle_end_time = 6;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The vehicleEndTime. |
getVehicleEndTimeOrBuilder()
publicTimestampOrBuildergetVehicleEndTimeOrBuilder()Time at which the vehicle finishes its route.
.google.protobuf.Timestamp vehicle_end_time = 6;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getVehicleIndex()
publicintgetVehicleIndex() Vehicle performing the route, identified by its index in the source
ShipmentModel.
int32 vehicle_index = 1;
| Returns | |
|---|---|
| Type | Description |
int |
The vehicleIndex. |
getVehicleLabel()
publicStringgetVehicleLabel() 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()
publicByteStringgetVehicleLabelBytes() 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()
publicTimestampgetVehicleStartTime()Time at which the vehicle starts its route.
.google.protobuf.Timestamp vehicle_start_time = 5;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The vehicleStartTime. |
getVehicleStartTimeOrBuilder()
publicTimestampOrBuildergetVehicleStartTimeOrBuilder()Time at which the vehicle starts its route.
.google.protobuf.Timestamp vehicle_start_time = 5;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getVisits(int index)
publicShipmentRoute.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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.Visit |
|
getVisitsCount()
publicintgetVisitsCount()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()
publicList<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)
publicShipmentRoute.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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.VisitOrBuilder |
|
getVisitsOrBuilderList()
publicList<?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;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.optimization.v1.ShipmentRoute.VisitOrBuilder> |
|
hasDelayBeforeVehicleEnd() (deprecated)
publicbooleanhasDelayBeforeVehicleEnd()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()
publicbooleanhasMetrics()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()
publicbooleanhasRoutePolyline()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)
publicbooleanhasVehicleDetour()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()
publicbooleanhasVehicleEndTime()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()
publicbooleanhasVehicleStartTime()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. |
hashCode()
publicinthashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
publicShipmentRoute.BuildernewBuilderForType()| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedShipmentRoute.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
publicShipmentRoute.BuildertoBuilder()| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.Builder |
|
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|