Class ShipmentRoute.Transition (1.43.0)

public static final class ShipmentRoute.Transition extends GeneratedMessageV3 implements ShipmentRoute.TransitionOrBuilder

Transition between two events on the route. See the description of ShipmentRoute.

If the vehicle does not have a start_location and/or end_location, the corresponding travel metrics are 0.

Protobuf type google.cloud.optimization.v1.ShipmentRoute.Transition

Static Fields

BREAK_DURATION_FIELD_NUMBER

public static final int BREAK_DURATION_FIELD_NUMBER
Field Value
Type Description
int

DELAY_DURATION_FIELD_NUMBER

public static final int DELAY_DURATION_FIELD_NUMBER
Field Value
Type Description
int

LOADS_FIELD_NUMBER

public static final int LOADS_FIELD_NUMBER
Field Value
Type Description
int

ROUTE_POLYLINE_FIELD_NUMBER

public static final int ROUTE_POLYLINE_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_DURATION_FIELD_NUMBER

public static final int TOTAL_DURATION_FIELD_NUMBER
Field Value
Type Description
int

TRAFFIC_INFO_UNAVAILABLE_FIELD_NUMBER

public static final int TRAFFIC_INFO_UNAVAILABLE_FIELD_NUMBER
Field Value
Type Description
int

TRAVEL_DISTANCE_METERS_FIELD_NUMBER

public static final int TRAVEL_DISTANCE_METERS_FIELD_NUMBER
Field Value
Type Description
int

TRAVEL_DURATION_FIELD_NUMBER

public static final int TRAVEL_DURATION_FIELD_NUMBER
Field Value
Type Description
int

VEHICLE_LOADS_FIELD_NUMBER

public static final int VEHICLE_LOADS_FIELD_NUMBER
Field Value
Type Description
int

WAIT_DURATION_FIELD_NUMBER

public static final int WAIT_DURATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ShipmentRoute.Transition getDefaultInstance()
Returns
Type Description
ShipmentRoute.Transition

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ShipmentRoute.Transition.Builder newBuilder()
Returns
Type Description
ShipmentRoute.Transition.Builder

newBuilder(ShipmentRoute.Transition prototype)

public static ShipmentRoute.Transition.Builder newBuilder(ShipmentRoute.Transition prototype)
Parameter
Name Description
prototype ShipmentRoute.Transition
Returns
Type Description
ShipmentRoute.Transition.Builder

parseDelimitedFrom(InputStream input)

public static ShipmentRoute.Transition parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ShipmentRoute.Transition
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.Transition parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.Transition
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ShipmentRoute.Transition parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ShipmentRoute.Transition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.Transition parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.Transition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ShipmentRoute.Transition parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ShipmentRoute.Transition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.Transition parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.Transition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ShipmentRoute.Transition parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ShipmentRoute.Transition
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.Transition parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.Transition
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ShipmentRoute.Transition parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ShipmentRoute.Transition
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.Transition parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.Transition
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ShipmentRoute.Transition parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ShipmentRoute.Transition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.Transition parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.Transition
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ShipmentRoute.Transition> parser()
Returns
Type Description
Parser<Transition>

Methods

containsVehicleLoads(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBreakDuration()

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

getDefaultInstanceForType()

public ShipmentRoute.Transition getDefaultInstanceForType()
Returns
Type Description
ShipmentRoute.Transition

getDelayDuration()

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

getParserForType()

public Parser<ShipmentRoute.Transition> getParserForType()
Returns
Type Description
Parser<Transition>
Overrides

getRoutePolyline()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Returns
Type Description
TimestampOrBuilder

getTotalDuration()

public 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 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 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 double getTravelDistanceMeters()

Distance traveled during the transition.

double travel_distance_meters = 2;

Returns
Type Description
double

The travelDistanceMeters.

getTravelDuration()

public Duration getTravelDuration()

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Returns
Type Description
Duration

The travelDuration.

getTravelDurationOrBuilder()

public DurationOrBuilder getTravelDurationOrBuilder()

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Returns
Type Description
DurationOrBuilder

getVehicleLoads() (deprecated)

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

Use #getVehicleLoadsMap() instead.

Returns
Type Description
Map<String,VehicleLoad>

getVehicleLoadsCount()

public 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 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 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 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 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 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ShipmentRoute.Transition.Builder newBuilderForType()
Returns
Type Description
ShipmentRoute.Transition.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ShipmentRoute.Transition.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ShipmentRoute.Transition.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ShipmentRoute.Transition.Builder toBuilder()
Returns
Type Description
ShipmentRoute.Transition.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException