Interface ShipmentRoute.TransitionOrBuilder (1.62.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
publicstaticinterface ShipmentRoute.TransitionOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsVehicleLoads(String key)
publicabstractbooleancontainsVehicleLoads(Stringkey)Vehicle loads during this transition, for each type that either appears in this vehicle's Vehicle.load_limits, or that have non-zero Shipment.load_demands on some shipment performed on this route.
The loads during the first transition are the starting loads of the
vehicle route. Then, after each visit, the visit's load_demands are
either added or subtracted to get the next transition's loads, depending
on whether the visit was a pickup or a delivery.
map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> vehicle_loads = 11;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getBreakDuration()
publicabstractDurationgetBreakDuration()Sum of the duration of the breaks occurring during this transition, if any. Details about each break's start time and duration are stored in ShipmentRoute.breaks.
.google.protobuf.Duration break_duration = 5;
| Returns | |
|---|---|
| Type | Description |
Duration |
The breakDuration. |
getBreakDurationOrBuilder()
publicabstractDurationOrBuildergetBreakDurationOrBuilder()Sum of the duration of the breaks occurring during this transition, if any. Details about each break's start time and duration are stored in ShipmentRoute.breaks.
.google.protobuf.Duration break_duration = 5;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getDelayDuration()
publicabstractDurationgetDelayDuration() Sum of the delay durations applied to this transition. If any, the delay
starts exactly delay_duration seconds before the next event (visit or
vehicle end). See
TransitionAttributes.delay.
.google.protobuf.Duration delay_duration = 4;
| Returns | |
|---|---|
| Type | Description |
Duration |
The delayDuration. |
getDelayDurationOrBuilder()
publicabstractDurationOrBuildergetDelayDurationOrBuilder() Sum of the delay durations applied to this transition. If any, the delay
starts exactly delay_duration seconds before the next event (visit or
vehicle end). See
TransitionAttributes.delay.
.google.protobuf.Duration delay_duration = 4;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getLoads(int index) (deprecated)
publicabstractCapacityQuantitygetLoads(intindex)Deprecated: Use Transition.vehicle_loads instead.
repeated .google.cloud.optimization.v1.CapacityQuantity loads = 10 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantity |
|
getLoadsCount() (deprecated)
publicabstractintgetLoadsCount()Deprecated: Use Transition.vehicle_loads instead.
repeated .google.cloud.optimization.v1.CapacityQuantity loads = 10 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
int |
|
getLoadsList() (deprecated)
publicabstractList<CapacityQuantity>getLoadsList()Deprecated: Use Transition.vehicle_loads instead.
repeated .google.cloud.optimization.v1.CapacityQuantity loads = 10 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
List<CapacityQuantity> |
|
getLoadsOrBuilder(int index) (deprecated)
publicabstractCapacityQuantityOrBuildergetLoadsOrBuilder(intindex)Deprecated: Use Transition.vehicle_loads instead.
repeated .google.cloud.optimization.v1.CapacityQuantity loads = 10 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantityOrBuilder |
|
getLoadsOrBuilderList() (deprecated)
publicabstractList<?extendsCapacityQuantityOrBuilder>getLoadsOrBuilderList()Deprecated: Use Transition.vehicle_loads instead.
repeated .google.cloud.optimization.v1.CapacityQuantity loads = 10 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.optimization.v1.CapacityQuantityOrBuilder> |
|
getRoutePolyline()
publicabstractShipmentRoute.EncodedPolylinegetRoutePolyline()The encoded polyline representation of the route followed during the transition. This field is only populated if [populate_transition_polylines] [google.cloud.optimization.v1.OptimizeToursRequest.populate_transition_polylines] is set to true.
.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 9;
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.EncodedPolyline |
The routePolyline. |
getRoutePolylineOrBuilder()
publicabstractShipmentRoute.EncodedPolylineOrBuildergetRoutePolylineOrBuilder()The encoded polyline representation of the route followed during the transition. This field is only populated if [populate_transition_polylines] [google.cloud.optimization.v1.OptimizeToursRequest.populate_transition_polylines] is set to true.
.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 9;
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.EncodedPolylineOrBuilder |
|
getStartTime()
publicabstractTimestampgetStartTime()Start time of this transition.
.google.protobuf.Timestamp start_time = 8;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The startTime. |
getStartTimeOrBuilder()
publicabstractTimestampOrBuildergetStartTimeOrBuilder()Start time of this transition.
.google.protobuf.Timestamp start_time = 8;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getTotalDuration()
publicabstractDurationgetTotalDuration()Total duration of the transition, provided for convenience. It is equal to:
- next visit
start_time(orvehicle_end_timeif this is the last transition) - this transition'sstart_time; - if
ShipmentRoute.has_traffic_infeasibilitiesis false, the following additionally holds:total_duration = travel_duration + delay_duration - break_duration + wait_duration.
.google.protobuf.Duration total_duration = 7;
| Returns | |
|---|---|
| Type | Description |
Duration |
The totalDuration. |
getTotalDurationOrBuilder()
publicabstractDurationOrBuildergetTotalDurationOrBuilder()Total duration of the transition, provided for convenience. It is equal to:
- next visit
start_time(orvehicle_end_timeif this is the last transition) - this transition'sstart_time; - if
ShipmentRoute.has_traffic_infeasibilitiesis false, the following additionally holds:total_duration = travel_duration + delay_duration - break_duration + wait_duration.
.google.protobuf.Duration total_duration = 7;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getTrafficInfoUnavailable()
publicabstractbooleangetTrafficInfoUnavailable() When traffic is requested via
[OptimizeToursRequest.consider_road_traffic]
[google.cloud.optimization.v1.OptimizeToursRequest.consider_road_traffic],
and the traffic info couldn't be retrieved for a Transition, this
boolean is set to true. This may be temporary (rare hiccup in the
realtime traffic servers) or permanent (no data for this location).
bool traffic_info_unavailable = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
The trafficInfoUnavailable. |
getTravelDistanceMeters()
publicabstractdoublegetTravelDistanceMeters()Distance traveled during the transition.
double travel_distance_meters = 2;
| Returns | |
|---|---|
| Type | Description |
double |
The travelDistanceMeters. |
getTravelDuration()
publicabstractDurationgetTravelDuration()Travel duration during this transition.
.google.protobuf.Duration travel_duration = 1;
| Returns | |
|---|---|
| Type | Description |
Duration |
The travelDuration. |
getTravelDurationOrBuilder()
publicabstractDurationOrBuildergetTravelDurationOrBuilder()Travel duration during this transition.
.google.protobuf.Duration travel_duration = 1;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getVehicleLoads() (deprecated)
publicabstractMap<String,ShipmentRoute.VehicleLoad>getVehicleLoads()Use #getVehicleLoadsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,VehicleLoad> |
|
getVehicleLoadsCount()
publicabstractintgetVehicleLoadsCount()Vehicle loads during this transition, for each type that either appears in this vehicle's Vehicle.load_limits, or that have non-zero Shipment.load_demands on some shipment performed on this route.
The loads during the first transition are the starting loads of the
vehicle route. Then, after each visit, the visit's load_demands are
either added or subtracted to get the next transition's loads, depending
on whether the visit was a pickup or a delivery.
map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> vehicle_loads = 11;
| Returns | |
|---|---|
| Type | Description |
int |
|
getVehicleLoadsMap()
publicabstractMap<String,ShipmentRoute.VehicleLoad>getVehicleLoadsMap()Vehicle loads during this transition, for each type that either appears in this vehicle's Vehicle.load_limits, or that have non-zero Shipment.load_demands on some shipment performed on this route.
The loads during the first transition are the starting loads of the
vehicle route. Then, after each visit, the visit's load_demands are
either added or subtracted to get the next transition's loads, depending
on whether the visit was a pickup or a delivery.
map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> vehicle_loads = 11;
| Returns | |
|---|---|
| Type | Description |
Map<String,VehicleLoad> |
|
getVehicleLoadsOrDefault(String key, ShipmentRoute.VehicleLoad defaultValue)
publicabstractShipmentRoute.VehicleLoadgetVehicleLoadsOrDefault(Stringkey,ShipmentRoute.VehicleLoaddefaultValue)Vehicle loads during this transition, for each type that either appears in this vehicle's Vehicle.load_limits, or that have non-zero Shipment.load_demands on some shipment performed on this route.
The loads during the first transition are the starting loads of the
vehicle route. Then, after each visit, the visit's load_demands are
either added or subtracted to get the next transition's loads, depending
on whether the visit was a pickup or a delivery.
map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> vehicle_loads = 11;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
ShipmentRoute.VehicleLoad |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.VehicleLoad |
|
getVehicleLoadsOrThrow(String key)
publicabstractShipmentRoute.VehicleLoadgetVehicleLoadsOrThrow(Stringkey)Vehicle loads during this transition, for each type that either appears in this vehicle's Vehicle.load_limits, or that have non-zero Shipment.load_demands on some shipment performed on this route.
The loads during the first transition are the starting loads of the
vehicle route. Then, after each visit, the visit's load_demands are
either added or subtracted to get the next transition's loads, depending
on whether the visit was a pickup or a delivery.
map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> vehicle_loads = 11;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
ShipmentRoute.VehicleLoad |
|
getWaitDuration()
publicabstractDurationgetWaitDuration()Time spent waiting during this transition. Wait duration corresponds to idle time and does not include break time. Also note that this wait time may be split into several non-contiguous intervals.
.google.protobuf.Duration wait_duration = 6;
| Returns | |
|---|---|
| Type | Description |
Duration |
The waitDuration. |
getWaitDurationOrBuilder()
publicabstractDurationOrBuildergetWaitDurationOrBuilder()Time spent waiting during this transition. Wait duration corresponds to idle time and does not include break time. Also note that this wait time may be split into several non-contiguous intervals.
.google.protobuf.Duration wait_duration = 6;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
hasBreakDuration()
publicabstractbooleanhasBreakDuration()Sum of the duration of the breaks occurring during this transition, if any. Details about each break's start time and duration are stored in ShipmentRoute.breaks.
.google.protobuf.Duration break_duration = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the breakDuration field is set. |
hasDelayDuration()
publicabstractbooleanhasDelayDuration() Sum of the delay durations applied to this transition. If any, the delay
starts exactly delay_duration seconds before the next event (visit or
vehicle end). See
TransitionAttributes.delay.
.google.protobuf.Duration delay_duration = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the delayDuration field is set. |
hasRoutePolyline()
publicabstractbooleanhasRoutePolyline()The encoded polyline representation of the route followed during the transition. This field is only populated if [populate_transition_polylines] [google.cloud.optimization.v1.OptimizeToursRequest.populate_transition_polylines] is set to true.
.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 9;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the routePolyline field is set. |
hasStartTime()
publicabstractbooleanhasStartTime()Start time of this transition.
.google.protobuf.Timestamp start_time = 8;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the startTime field is set. |
hasTotalDuration()
publicabstractbooleanhasTotalDuration()Total duration of the transition, provided for convenience. It is equal to:
- next visit
start_time(orvehicle_end_timeif this is the last transition) - this transition'sstart_time; - if
ShipmentRoute.has_traffic_infeasibilitiesis false, the following additionally holds:total_duration = travel_duration + delay_duration - break_duration + wait_duration.
.google.protobuf.Duration total_duration = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the totalDuration field is set. |
hasTravelDuration()
publicabstractbooleanhasTravelDuration()Travel duration during this transition.
.google.protobuf.Duration travel_duration = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the travelDuration field is set. |
hasWaitDuration()
publicabstractbooleanhasWaitDuration()Time spent waiting during this transition. Wait duration corresponds to idle time and does not include break time. Also note that this wait time may be split into several non-contiguous intervals.
.google.protobuf.Duration wait_duration = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the waitDuration field is set. |