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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ShipmentRoute.Transition.Builder newBuilder()
newBuilder(ShipmentRoute.Transition prototype)
public static ShipmentRoute.Transition.Builder newBuilder(ShipmentRoute.Transition prototype)
public static ShipmentRoute.Transition parseDelimitedFrom(InputStream input)
public static ShipmentRoute.Transition parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ShipmentRoute.Transition parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ShipmentRoute.Transition parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ShipmentRoute.Transition parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ShipmentRoute.Transition parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ShipmentRoute.Transition parseFrom(CodedInputStream input)
public static ShipmentRoute.Transition parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ShipmentRoute.Transition parseFrom(InputStream input)
public static ShipmentRoute.Transition parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ShipmentRoute.Transition parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ShipmentRoute.Transition parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ShipmentRoute.Transition> parser()
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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;
getDefaultInstanceForType()
public ShipmentRoute.Transition getDefaultInstanceForType()
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;
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 |
|---|
| Name | Description |
index | int
|
getLoadsCount()
public int getLoadsCount()
Deprecated: Use
Transition.vehicle_loads
instead.
repeated .google.cloud.optimization.v1.CapacityQuantity loads = 10 [deprecated = true];
| Returns |
|---|
| Type | Description |
int | |
getLoadsList()
public List<CapacityQuantity> getLoadsList()
Deprecated: Use
Transition.vehicle_loads
instead.
repeated .google.cloud.optimization.v1.CapacityQuantity loads = 10 [deprecated = true];
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 |
|---|
| Name | Description |
index | int
|
getLoadsOrBuilderList()
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()
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;
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;
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;
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;
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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getVehicleLoads()
public Map<String,ShipmentRoute.VehicleLoad> getVehicleLoads()
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;
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;
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
|
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;
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()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ShipmentRoute.Transition.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ShipmentRoute.Transition.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ShipmentRoute.Transition.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
