Interface ShipmentRoute.TransitionOrBuilder (1.47.0)

Version 1.47.0

• 1.51.0 (latest)
• 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 static interface ShipmentRoute.TransitionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsVehicleLoads(String key)

public abstract boolean containsVehicleLoads(String key)

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()

public abstract Duration getBreakDuration()

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()

public abstract DurationOrBuilder getBreakDurationOrBuilder()

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()

public abstract Duration getDelayDuration()

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()

public abstract DurationOrBuilder getDelayDurationOrBuilder()

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)

public abstract CapacityQuantity getLoads(int index)

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)

public abstract int getLoadsCount()

Deprecated: Use Transition.vehicle_loads instead.

repeated .google.cloud.optimization.v1.CapacityQuantity loads = 10 [deprecated = true];

Returns
Type	Description
int

getLoadsList() (deprecated)

public abstract List<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)

public abstract CapacityQuantityOrBuilder getLoadsOrBuilder(int index)

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)

public abstract List<? extends CapacityQuantityOrBuilder> 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()

public abstract ShipmentRoute.EncodedPolyline getRoutePolyline()

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()

public abstract ShipmentRoute.EncodedPolylineOrBuilder getRoutePolylineOrBuilder()

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()

public abstract Timestamp getStartTime()

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Returns
Type	Description
Timestamp	The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Returns
Type	Description
TimestampOrBuilder

getTotalDuration()

public abstract Duration getTotalDuration()

Total duration of the transition, provided for convenience. It is equal to:

• next visit start_time (or vehicle_end_time if this is the last transition) - this transition's start_time;
• if ShipmentRoute.has_traffic_infeasibilities is 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()

public abstract DurationOrBuilder getTotalDurationOrBuilder()

Total duration of the transition, provided for convenience. It is equal to:

• next visit start_time (or vehicle_end_time if this is the last transition) - this transition's start_time;
• if ShipmentRoute.has_traffic_infeasibilities is 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()

public abstract boolean getTrafficInfoUnavailable()

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()

public abstract double getTravelDistanceMeters()

Distance traveled during the transition.

double travel_distance_meters = 2;

Returns
Type	Description
double	The travelDistanceMeters.

getTravelDuration()

public abstract Duration getTravelDuration()

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Returns
Type	Description
Duration	The travelDuration.

getTravelDurationOrBuilder()

public abstract DurationOrBuilder getTravelDurationOrBuilder()

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Returns
Type	Description
DurationOrBuilder

getVehicleLoads() (deprecated)

public abstract Map<String,ShipmentRoute.VehicleLoad> getVehicleLoads()

Use #getVehicleLoadsMap() instead.

Returns
Type	Description
Map<String,VehicleLoad>

getVehicleLoadsCount()

public abstract int getVehicleLoadsCount()

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()

public abstract Map<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)

public abstract ShipmentRoute.VehicleLoad getVehicleLoadsOrDefault(String key, ShipmentRoute.VehicleLoad defaultValue)

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)

public abstract ShipmentRoute.VehicleLoad getVehicleLoadsOrThrow(String key)

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()

public abstract Duration getWaitDuration()

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()

public abstract DurationOrBuilder getWaitDurationOrBuilder()

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()

public abstract boolean hasBreakDuration()

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()

public abstract boolean hasDelayDuration()

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()

public abstract boolean hasRoutePolyline()

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()

public abstract boolean hasStartTime()

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Returns
Type	Description
boolean	Whether the startTime field is set.

hasTotalDuration()

public abstract boolean hasTotalDuration()

Total duration of the transition, provided for convenience. It is equal to:

• next visit start_time (or vehicle_end_time if this is the last transition) - this transition's start_time;
• if ShipmentRoute.has_traffic_infeasibilities is 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()

public abstract boolean hasTravelDuration()

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Returns
Type	Description
boolean	Whether the travelDuration field is set.

hasWaitDuration()

public abstract boolean hasWaitDuration()

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.