Class ShipmentRoute.Transition (1.4.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
TypeDescription
int

DELAY_DURATION_FIELD_NUMBER

public static final int DELAY_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

LOADS_FIELD_NUMBER

public static final int LOADS_FIELD_NUMBER
Field Value
TypeDescription
int

ROUTE_POLYLINE_FIELD_NUMBER

public static final int ROUTE_POLYLINE_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_DURATION_FIELD_NUMBER

public static final int TOTAL_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

TRAFFIC_INFO_UNAVAILABLE_FIELD_NUMBER

public static final int TRAFFIC_INFO_UNAVAILABLE_FIELD_NUMBER
Field Value
TypeDescription
int

TRAVEL_DISTANCE_METERS_FIELD_NUMBER

public static final int TRAVEL_DISTANCE_METERS_FIELD_NUMBER
Field Value
TypeDescription
int

TRAVEL_DURATION_FIELD_NUMBER

public static final int TRAVEL_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

VEHICLE_LOADS_FIELD_NUMBER

public static final int VEHICLE_LOADS_FIELD_NUMBER
Field Value
TypeDescription
int

WAIT_DURATION_FIELD_NUMBER

public static final int WAIT_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ShipmentRoute.Transition getDefaultInstance()
Returns
TypeDescription
ShipmentRoute.Transition

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ShipmentRoute.Transition.Builder newBuilder()
Returns
TypeDescription
ShipmentRoute.Transition.Builder

newBuilder(ShipmentRoute.Transition prototype)

public static ShipmentRoute.Transition.Builder newBuilder(ShipmentRoute.Transition prototype)
Parameter
NameDescription
prototypeShipmentRoute.Transition
Returns
TypeDescription
ShipmentRoute.Transition.Builder

parseDelimitedFrom(InputStream input)

public static ShipmentRoute.Transition parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ShipmentRoute.Transition
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.Transition parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentRoute.Transition
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ShipmentRoute.Transition parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ShipmentRoute.Transition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.Transition parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentRoute.Transition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ShipmentRoute.Transition parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ShipmentRoute.Transition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.Transition parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentRoute.Transition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ShipmentRoute.Transition parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ShipmentRoute.Transition
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.Transition parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentRoute.Transition
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ShipmentRoute.Transition parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ShipmentRoute.Transition
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.Transition parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentRoute.Transition
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ShipmentRoute.Transition parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ShipmentRoute.Transition
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ShipmentRoute.Transition parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentRoute.Transition
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ShipmentRoute.Transition> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
DurationOrBuilder

getDefaultInstanceForType()

public ShipmentRoute.Transition getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
DurationOrBuilder

getLoads(int index)

public CapacityQuantity getLoads(int index)

Deprecated: Use [Transition.vehicle_loads][] instead.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantity

getLoadsCount()

public int getLoadsCount()

Deprecated: Use [Transition.vehicle_loads][] instead.

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

Returns
TypeDescription
int

getLoadsList()

public List<CapacityQuantity> getLoadsList()

Deprecated: Use [Transition.vehicle_loads][] instead.

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

Returns
TypeDescription
List<CapacityQuantity>

getLoadsOrBuilder(int index)

public CapacityQuantityOrBuilder getLoadsOrBuilder(int index)

Deprecated: Use [Transition.vehicle_loads][] instead.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantityOrBuilder

getLoadsOrBuilderList()

public List<? extends CapacityQuantityOrBuilder> getLoadsOrBuilderList()

Deprecated: Use [Transition.vehicle_loads][] instead.

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

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

getParserForType()

public Parser<ShipmentRoute.Transition> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ShipmentRoute.EncodedPolylineOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStartTime()

public Timestamp getStartTime()

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The trafficInfoUnavailable.

getTravelDistanceMeters()

public double getTravelDistanceMeters()

Distance traveled during the transition.

double travel_distance_meters = 2;

Returns
TypeDescription
double

The travelDistanceMeters.

getTravelDuration()

public Duration getTravelDuration()

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Returns
TypeDescription
Duration

The travelDuration.

getTravelDurationOrBuilder()

public DurationOrBuilder getTravelDurationOrBuilder()

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Returns
TypeDescription
DurationOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getVehicleLoads()

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

Use #getVehicleLoadsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueShipmentRoute.VehicleLoad
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the routePolyline field is set.

hasStartTime()

public boolean hasStartTime()

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the totalDuration field is set.

hasTravelDuration()

public boolean hasTravelDuration()

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the waitDuration field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ShipmentRoute.Transition.Builder newBuilderForType()
Returns
TypeDescription
ShipmentRoute.Transition.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ShipmentRoute.Transition.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ShipmentRoute.Transition.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ShipmentRoute.Transition.Builder toBuilder()
Returns
TypeDescription
ShipmentRoute.Transition.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException