Class ShipmentRoute.Transition.Builder (1.5.0)

public static final class ShipmentRoute.Transition.Builder extends GeneratedMessageV3.Builder<ShipmentRoute.Transition.Builder> 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 Methods

getDescriptor()

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

Methods

addAllLoads(Iterable<? extends CapacityQuantity> values)

public ShipmentRoute.Transition.Builder addAllLoads(Iterable<? extends CapacityQuantity> values)

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

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.optimization.v1.CapacityQuantity>
Returns
TypeDescription
ShipmentRoute.Transition.Builder

addLoads(CapacityQuantity value)

public ShipmentRoute.Transition.Builder addLoads(CapacityQuantity value)

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

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

Parameter
NameDescription
valueCapacityQuantity
Returns
TypeDescription
ShipmentRoute.Transition.Builder

addLoads(CapacityQuantity.Builder builderForValue)

public ShipmentRoute.Transition.Builder addLoads(CapacityQuantity.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueCapacityQuantity.Builder
Returns
TypeDescription
ShipmentRoute.Transition.Builder

addLoads(int index, CapacityQuantity value)

public ShipmentRoute.Transition.Builder addLoads(int index, CapacityQuantity value)

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

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

Parameters
NameDescription
indexint
valueCapacityQuantity
Returns
TypeDescription
ShipmentRoute.Transition.Builder

addLoads(int index, CapacityQuantity.Builder builderForValue)

public ShipmentRoute.Transition.Builder addLoads(int index, CapacityQuantity.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueCapacityQuantity.Builder
Returns
TypeDescription
ShipmentRoute.Transition.Builder

addLoadsBuilder()

public CapacityQuantity.Builder addLoadsBuilder()

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

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

Returns
TypeDescription
CapacityQuantity.Builder

addLoadsBuilder(int index)

public CapacityQuantity.Builder addLoadsBuilder(int index)

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantity.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ShipmentRoute.Transition.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ShipmentRoute.Transition.Builder
Overrides

build()

public ShipmentRoute.Transition build()
Returns
TypeDescription
ShipmentRoute.Transition

buildPartial()

public ShipmentRoute.Transition buildPartial()
Returns
TypeDescription
ShipmentRoute.Transition

clear()

public ShipmentRoute.Transition.Builder clear()
Returns
TypeDescription
ShipmentRoute.Transition.Builder
Overrides

clearBreakDuration()

public ShipmentRoute.Transition.Builder clearBreakDuration()

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
ShipmentRoute.Transition.Builder

clearDelayDuration()

public ShipmentRoute.Transition.Builder clearDelayDuration()

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
ShipmentRoute.Transition.Builder

clearField(Descriptors.FieldDescriptor field)

public ShipmentRoute.Transition.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ShipmentRoute.Transition.Builder
Overrides

clearLoads()

public ShipmentRoute.Transition.Builder clearLoads()

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

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

Returns
TypeDescription
ShipmentRoute.Transition.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ShipmentRoute.Transition.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ShipmentRoute.Transition.Builder
Overrides

clearRoutePolyline()

public ShipmentRoute.Transition.Builder clearRoutePolyline()

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.Transition.Builder

clearStartTime()

public ShipmentRoute.Transition.Builder clearStartTime()

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Returns
TypeDescription
ShipmentRoute.Transition.Builder

clearTotalDuration()

public ShipmentRoute.Transition.Builder clearTotalDuration()

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
ShipmentRoute.Transition.Builder

clearTrafficInfoUnavailable()

public ShipmentRoute.Transition.Builder clearTrafficInfoUnavailable()

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
ShipmentRoute.Transition.Builder

This builder for chaining.

clearTravelDistanceMeters()

public ShipmentRoute.Transition.Builder clearTravelDistanceMeters()

Distance traveled during the transition.

double travel_distance_meters = 2;

Returns
TypeDescription
ShipmentRoute.Transition.Builder

This builder for chaining.

clearTravelDuration()

public ShipmentRoute.Transition.Builder clearTravelDuration()

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Returns
TypeDescription
ShipmentRoute.Transition.Builder

clearVehicleLoads()

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

clearWaitDuration()

public ShipmentRoute.Transition.Builder clearWaitDuration()

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
ShipmentRoute.Transition.Builder

clone()

public ShipmentRoute.Transition.Builder clone()
Returns
TypeDescription
ShipmentRoute.Transition.Builder
Overrides

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

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.

getBreakDurationBuilder()

public Duration.Builder getBreakDurationBuilder()

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
Builder

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.

getDelayDurationBuilder()

public Duration.Builder getDelayDurationBuilder()

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
Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

getLoadsBuilder(int index)

public CapacityQuantity.Builder getLoadsBuilder(int index)

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantity.Builder

getLoadsBuilderList()

public List<CapacityQuantity.Builder> getLoadsBuilderList()

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

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

Returns
TypeDescription
List<Builder>

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>

getMutableVehicleLoads()

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

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,VehicleLoad>

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.

getRoutePolylineBuilder()

public ShipmentRoute.EncodedPolyline.Builder getRoutePolylineBuilder()

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

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

getStartTime()

public Timestamp getStartTime()

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Returns
TypeDescription
Builder

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.

getTotalDurationBuilder()

public Duration.Builder getTotalDurationBuilder()

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
Builder

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.

getTravelDurationBuilder()

public Duration.Builder getTravelDurationBuilder()

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Returns
TypeDescription
Builder

getTravelDurationOrBuilder()

public DurationOrBuilder getTravelDurationOrBuilder()

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Returns
TypeDescription
DurationOrBuilder

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.

getWaitDurationBuilder()

public Duration.Builder getWaitDurationBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

internalGetMutableMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBreakDuration(Duration value)

public ShipmentRoute.Transition.Builder mergeBreakDuration(Duration value)

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ShipmentRoute.Transition.Builder

mergeDelayDuration(Duration value)

public ShipmentRoute.Transition.Builder mergeDelayDuration(Duration value)

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ShipmentRoute.Transition.Builder

mergeFrom(ShipmentRoute.Transition other)

public ShipmentRoute.Transition.Builder mergeFrom(ShipmentRoute.Transition other)
Parameter
NameDescription
otherShipmentRoute.Transition
Returns
TypeDescription
ShipmentRoute.Transition.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ShipmentRoute.Transition.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ShipmentRoute.Transition.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ShipmentRoute.Transition.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ShipmentRoute.Transition.Builder
Overrides

mergeRoutePolyline(ShipmentRoute.EncodedPolyline value)

public ShipmentRoute.Transition.Builder mergeRoutePolyline(ShipmentRoute.EncodedPolyline value)

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;

Parameter
NameDescription
valueShipmentRoute.EncodedPolyline
Returns
TypeDescription
ShipmentRoute.Transition.Builder

mergeStartTime(Timestamp value)

public ShipmentRoute.Transition.Builder mergeStartTime(Timestamp value)

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
ShipmentRoute.Transition.Builder

mergeTotalDuration(Duration value)

public ShipmentRoute.Transition.Builder mergeTotalDuration(Duration value)

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ShipmentRoute.Transition.Builder

mergeTravelDuration(Duration value)

public ShipmentRoute.Transition.Builder mergeTravelDuration(Duration value)

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ShipmentRoute.Transition.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ShipmentRoute.Transition.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ShipmentRoute.Transition.Builder
Overrides

mergeWaitDuration(Duration value)

public ShipmentRoute.Transition.Builder mergeWaitDuration(Duration value)

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ShipmentRoute.Transition.Builder

putAllVehicleLoads(Map<String,ShipmentRoute.VehicleLoad> values)

public ShipmentRoute.Transition.Builder putAllVehicleLoads(Map<String,ShipmentRoute.VehicleLoad> values)

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
valuesMap<String,VehicleLoad>
Returns
TypeDescription
ShipmentRoute.Transition.Builder

putVehicleLoads(String key, ShipmentRoute.VehicleLoad value)

public ShipmentRoute.Transition.Builder putVehicleLoads(String key, ShipmentRoute.VehicleLoad value)

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
valueShipmentRoute.VehicleLoad
Returns
TypeDescription
ShipmentRoute.Transition.Builder

removeLoads(int index)

public ShipmentRoute.Transition.Builder removeLoads(int index)

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
ShipmentRoute.Transition.Builder

removeVehicleLoads(String key)

public ShipmentRoute.Transition.Builder removeVehicleLoads(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.Transition.Builder

setBreakDuration(Duration value)

public ShipmentRoute.Transition.Builder setBreakDuration(Duration value)

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setBreakDuration(Duration.Builder builderForValue)

public ShipmentRoute.Transition.Builder setBreakDuration(Duration.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setDelayDuration(Duration value)

public ShipmentRoute.Transition.Builder setDelayDuration(Duration value)

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setDelayDuration(Duration.Builder builderForValue)

public ShipmentRoute.Transition.Builder setDelayDuration(Duration.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ShipmentRoute.Transition.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ShipmentRoute.Transition.Builder
Overrides

setLoads(int index, CapacityQuantity value)

public ShipmentRoute.Transition.Builder setLoads(int index, CapacityQuantity value)

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

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

Parameters
NameDescription
indexint
valueCapacityQuantity
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setLoads(int index, CapacityQuantity.Builder builderForValue)

public ShipmentRoute.Transition.Builder setLoads(int index, CapacityQuantity.Builder builderForValue)

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

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

Parameters
NameDescription
indexint
builderForValueCapacityQuantity.Builder
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ShipmentRoute.Transition.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ShipmentRoute.Transition.Builder
Overrides

setRoutePolyline(ShipmentRoute.EncodedPolyline value)

public ShipmentRoute.Transition.Builder setRoutePolyline(ShipmentRoute.EncodedPolyline value)

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;

Parameter
NameDescription
valueShipmentRoute.EncodedPolyline
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setRoutePolyline(ShipmentRoute.EncodedPolyline.Builder builderForValue)

public ShipmentRoute.Transition.Builder setRoutePolyline(ShipmentRoute.EncodedPolyline.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueShipmentRoute.EncodedPolyline.Builder
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setStartTime(Timestamp value)

public ShipmentRoute.Transition.Builder setStartTime(Timestamp value)

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setStartTime(Timestamp.Builder builderForValue)

public ShipmentRoute.Transition.Builder setStartTime(Timestamp.Builder builderForValue)

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setTotalDuration(Duration value)

public ShipmentRoute.Transition.Builder setTotalDuration(Duration value)

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setTotalDuration(Duration.Builder builderForValue)

public ShipmentRoute.Transition.Builder setTotalDuration(Duration.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setTrafficInfoUnavailable(boolean value)

public ShipmentRoute.Transition.Builder setTrafficInfoUnavailable(boolean value)

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;

Parameter
NameDescription
valueboolean

The trafficInfoUnavailable to set.

Returns
TypeDescription
ShipmentRoute.Transition.Builder

This builder for chaining.

setTravelDistanceMeters(double value)

public ShipmentRoute.Transition.Builder setTravelDistanceMeters(double value)

Distance traveled during the transition.

double travel_distance_meters = 2;

Parameter
NameDescription
valuedouble

The travelDistanceMeters to set.

Returns
TypeDescription
ShipmentRoute.Transition.Builder

This builder for chaining.

setTravelDuration(Duration value)

public ShipmentRoute.Transition.Builder setTravelDuration(Duration value)

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setTravelDuration(Duration.Builder builderForValue)

public ShipmentRoute.Transition.Builder setTravelDuration(Duration.Builder builderForValue)

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ShipmentRoute.Transition.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ShipmentRoute.Transition.Builder
Overrides

setWaitDuration(Duration value)

public ShipmentRoute.Transition.Builder setWaitDuration(Duration value)

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
ShipmentRoute.Transition.Builder

setWaitDuration(Duration.Builder builderForValue)

public ShipmentRoute.Transition.Builder setWaitDuration(Duration.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ShipmentRoute.Transition.Builder