Class ShipmentRoute.Transition.Builder (1.43.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
Type Description
Descriptor

Methods

addAllLoads(Iterable<? extends CapacityQuantity> values) (deprecated)

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
Name Description
values Iterable<? extends com.google.cloud.optimization.v1.CapacityQuantity>
Returns
Type Description
ShipmentRoute.Transition.Builder

addLoads(CapacityQuantity value) (deprecated)

public ShipmentRoute.Transition.Builder addLoads(CapacityQuantity value)

Deprecated: Use Transition.vehicle_loads instead.

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

Parameter
Name Description
value CapacityQuantity
Returns
Type Description
ShipmentRoute.Transition.Builder

addLoads(CapacityQuantity.Builder builderForValue) (deprecated)

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
Name Description
builderForValue CapacityQuantity.Builder
Returns
Type Description
ShipmentRoute.Transition.Builder

addLoads(int index, CapacityQuantity value) (deprecated)

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
Name Description
index int
value CapacityQuantity
Returns
Type Description
ShipmentRoute.Transition.Builder

addLoads(int index, CapacityQuantity.Builder builderForValue) (deprecated)

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
Name Description
index int
builderForValue CapacityQuantity.Builder
Returns
Type Description
ShipmentRoute.Transition.Builder

addLoadsBuilder() (deprecated)

public CapacityQuantity.Builder addLoadsBuilder()

Deprecated: Use Transition.vehicle_loads instead.

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

Returns
Type Description
CapacityQuantity.Builder

addLoadsBuilder(int index) (deprecated)

public CapacityQuantity.Builder addLoadsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ShipmentRoute.Transition.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ShipmentRoute.Transition.Builder
Overrides

build()

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

buildPartial()

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

clear()

public ShipmentRoute.Transition.Builder clear()
Returns
Type Description
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
Type Description
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
Type Description
ShipmentRoute.Transition.Builder

clearField(Descriptors.FieldDescriptor field)

public ShipmentRoute.Transition.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ShipmentRoute.Transition.Builder
Overrides

clearLoads() (deprecated)

public ShipmentRoute.Transition.Builder clearLoads()

Deprecated: Use Transition.vehicle_loads instead.

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

Returns
Type Description
ShipmentRoute.Transition.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ShipmentRoute.Transition.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
ShipmentRoute.Transition.Builder

clearStartTime()

public ShipmentRoute.Transition.Builder clearStartTime()

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

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

This builder for chaining.

clearTravelDistanceMeters()

public ShipmentRoute.Transition.Builder clearTravelDistanceMeters()

Distance traveled during the transition.

double travel_distance_meters = 2;

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

clearVehicleLoads()

public ShipmentRoute.Transition.Builder clearVehicleLoads()
Returns
Type Description
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
Type Description
ShipmentRoute.Transition.Builder

clone()

public ShipmentRoute.Transition.Builder clone()
Returns
Type Description
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
Name Description
key String
Returns
Type Description
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
Type Description
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
Type Description
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
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.

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
Type Description
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
Type Description
DurationOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getLoadsBuilder(int index) (deprecated)

public CapacityQuantity.Builder getLoadsBuilder(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.Builder

getLoadsBuilderList() (deprecated)

public List<CapacityQuantity.Builder> getLoadsBuilderList()

Deprecated: Use Transition.vehicle_loads instead.

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

Returns
Type Description
List<Builder>

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>

getMutableVehicleLoads() (deprecated)

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

Use alternate mutation accessors instead.

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
ShipmentRoute.EncodedPolylineOrBuilder

getStartTime()

public Timestamp getStartTime()

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Returns
Type Description
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Start time of this transition.

.google.protobuf.Timestamp start_time = 8;

Returns
Type Description
Builder

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.

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
Type Description
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
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.

getTravelDurationBuilder()

public Duration.Builder getTravelDurationBuilder()

Travel duration during this transition.

.google.protobuf.Duration travel_duration = 1;

Returns
Type Description
Builder

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.

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
Type Description
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
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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
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
Name Description
value Duration
Returns
Type Description
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
Name Description
value Duration
Returns
Type Description
ShipmentRoute.Transition.Builder

mergeFrom(ShipmentRoute.Transition other)

public ShipmentRoute.Transition.Builder mergeFrom(ShipmentRoute.Transition other)
Parameter
Name Description
other ShipmentRoute.Transition
Returns
Type Description
ShipmentRoute.Transition.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ShipmentRoute.Transition.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ShipmentRoute.Transition.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ShipmentRoute.Transition.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
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
Name Description
value ShipmentRoute.EncodedPolyline
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
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
Name Description
value Duration
Returns
Type Description
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
Name Description
value Duration
Returns
Type Description
ShipmentRoute.Transition.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ShipmentRoute.Transition.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
value Duration
Returns
Type Description
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
Name Description
values Map<String,VehicleLoad>
Returns
Type Description
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
Name Description
key String
value ShipmentRoute.VehicleLoad
Returns
Type Description
ShipmentRoute.Transition.Builder

putVehicleLoadsBuilderIfAbsent(String key)

public ShipmentRoute.VehicleLoad.Builder putVehicleLoadsBuilderIfAbsent(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.Builder

removeLoads(int index) (deprecated)

public ShipmentRoute.Transition.Builder removeLoads(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
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
Name Description
key String
Returns
Type Description
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
Name Description
value Duration
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
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
Name Description
value Duration
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
ShipmentRoute.Transition.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ShipmentRoute.Transition.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ShipmentRoute.Transition.Builder
Overrides

setLoads(int index, CapacityQuantity value) (deprecated)

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
Name Description
index int
value CapacityQuantity
Returns
Type Description
ShipmentRoute.Transition.Builder

setLoads(int index, CapacityQuantity.Builder builderForValue) (deprecated)

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
Name Description
index int
builderForValue CapacityQuantity.Builder
Returns
Type Description
ShipmentRoute.Transition.Builder

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

public ShipmentRoute.Transition.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
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
Name Description
value ShipmentRoute.EncodedPolyline
Returns
Type Description
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
Name Description
builderForValue ShipmentRoute.EncodedPolyline.Builder
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
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
Name Description
value Duration
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
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
Name Description
value boolean

The trafficInfoUnavailable to set.

Returns
Type Description
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
Name Description
value double

The travelDistanceMeters to set.

Returns
Type Description
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
Name Description
value Duration
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
ShipmentRoute.Transition.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ShipmentRoute.Transition.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
value Duration
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
ShipmentRoute.Transition.Builder