Class ShipmentRoute.Builder (1.35.0)

publicstaticfinalclass ShipmentRoute.BuilderextendsGeneratedMessageV3.Builder<ShipmentRoute.Builder>implementsShipmentRouteOrBuilder

A vehicle's route can be decomposed, along the time axis, like this (we assume there are n visits): `| | | | | T[2], | | | | Transition | Visit #0 | | | V[2], | | | | #0 | aka | T[1] | V[1] | ... | V[n-1] | T[n] | | aka T[0] | V[0] | | | V[n-2],| | | | | | | | T[n-1] | | | ^ ^ ^ ^ ^ ^ ^ ^ vehicle V[0].start V[0].end V[1]. V[1]. V[n]. V[n]. vehicle start (arrival) (departure) start end start end endNote that we make a difference between:


"punctual events", such as the vehicle start and end and each visit's start
and end (aka arrival and departure). They happen at a given second.
"time intervals", such as the visits themselves, and the transition between
visits. Though time intervals can sometimes have zero duration, i.e. start
and end at the same second, they often have a positive duration.
Invariants:

If there are n visits, there are n+1 transitions.

A visit is always surrounded by a transition before it (same index) and a
transition after it (index + 1).
The vehicle start is always followed by transition #0.
The vehicle end is always preceded by transition #n.
Zooming in, here is what happens during a

Transition and a Visit


---+-------------------------------------+-----------------------------+-->
 | TRANSITION[i] | VISIT[i] |
 | | |
 | * TRAVEL: the vehicle moves from | PERFORM the visit: |
 | VISIT[i-1].departure_location to | |
 | VISIT[i].arrival_location, which | * Spend some time: |
 | takes a given travel duration | the "visit duration". |
 | and distance | |
 | | * Load or unload |
 | * BREAKS: the driver may have | some quantities from the |
 | breaks (e.g. lunch break). | vehicle: the "demand". |
 | | |
 | * WAIT: the driver/vehicle does | |
 | nothing. This can happen for | |
 | many reasons, for example when | |
 | the vehicle reaches the next | |
 | event's destination before the | |
 | start of its time window | |
 | | |
 | * DELAY: right before the next | |
 | arrival. E.g. the vehicle and/or | |
 | driver spends time unloading. | |
 | | |
---+-------------------------------------+-----------------------------+-->
 ^ ^ ^
V[i-1].end V[i].start V[i].end


Lastly, here is how the TRAVEL, BREAKS, DELAY and WAIT can be arranged
during a transition.They don't overlap.

The DELAY is unique and must be a contiguous period of time right
before the next visit (or vehicle end). Thus, it suffice to know the
delay duration to know its start and end time.
The BREAKS are contiguous, non-overlapping periods of time. The
response specifies the start time and duration of each break.
TRAVEL and WAIT are "preemptable": they can be interrupted several times
during this transition. Clients can assume that travel happens "as soon as
possible" and that "wait" fills the remaining time.
A (complex) example:


 TRANSITION[i]
--++-----+-----------------------------------------------------------++-->
|| | | | | | | ||
|| T | B | T | | B | | D ||
|| r | r | r | W | r | W | e ||
|| a | e | a | a | e | a | l ||
|| v | a | v | i | a | i | a ||
|| e | k | e | t | k | t | y ||
|| l | | l | | | | ||
|| | | | | | | ||
--++-----------------------------------------------------------------++-->

Protobuf type google.cloud.optimization.v1.ShipmentRoute

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ShipmentRoute.Builder

Implements

ShipmentRouteOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.notify()

Object.wait()

Object.wait(long,int)

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllBreaks(Iterable<? extends ShipmentRoute.Break> values)

publicShipmentRoute.BuilderaddAllBreaks(Iterable<?extendsShipmentRoute.Break>values)

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.optimization.v1.ShipmentRoute.Break>`

Returns
Type	Description
`ShipmentRoute.Builder`

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

publicShipmentRoute.BuilderaddAllEndLoads(Iterable<?extendsCapacityQuantity>values)

Deprecated: Use Transition.vehicle_loads instead. Vehicle loads upon arrival at its end location, for each type specified in Vehicle.capacities, start_load_intervals, end_load_intervals or demands. Exception: we omit loads for quantity types unconstrained by intervals and that don't have any non-zero demand on the route.

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.optimization.v1.CapacityQuantity>`

Returns
Type	Description
`ShipmentRoute.Builder`

addAllTransitions(Iterable<? extends ShipmentRoute.Transition> values)

publicShipmentRoute.BuilderaddAllTransitions(Iterable<?extendsShipmentRoute.Transition>values)

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.optimization.v1.ShipmentRoute.Transition>`

Returns
Type	Description
`ShipmentRoute.Builder`

addAllTravelSteps(Iterable<? extends ShipmentRoute.TravelStep> values) (deprecated)

publicShipmentRoute.BuilderaddAllTravelSteps(Iterable<?extendsShipmentRoute.TravelStep>values)

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.optimization.v1.ShipmentRoute.TravelStep>`

Returns
Type	Description
`ShipmentRoute.Builder`

addAllVisits(Iterable<? extends ShipmentRoute.Visit> values)

publicShipmentRoute.BuilderaddAllVisits(Iterable<?extendsShipmentRoute.Visit>values)

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.optimization.v1.ShipmentRoute.Visit>`

Returns
Type	Description
`ShipmentRoute.Builder`

addBreaks(ShipmentRoute.Break value)

publicShipmentRoute.BuilderaddBreaks(ShipmentRoute.Breakvalue)

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Parameter
Name	Description
`value`	`ShipmentRoute.Break`

Returns
Type	Description
`ShipmentRoute.Builder`

addBreaks(ShipmentRoute.Break.Builder builderForValue)

publicShipmentRoute.BuilderaddBreaks(ShipmentRoute.Break.BuilderbuilderForValue)

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Parameter
Name	Description
`builderForValue`	`ShipmentRoute.Break.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

addBreaks(int index, ShipmentRoute.Break value)

publicShipmentRoute.BuilderaddBreaks(intindex,ShipmentRoute.Breakvalue)

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Parameters
Name	Description
`index`	`int`
`value`	`ShipmentRoute.Break`

Returns
Type	Description
`ShipmentRoute.Builder`

addBreaks(int index, ShipmentRoute.Break.Builder builderForValue)

publicShipmentRoute.BuilderaddBreaks(intindex,ShipmentRoute.Break.BuilderbuilderForValue)

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ShipmentRoute.Break.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

addBreaksBuilder()

publicShipmentRoute.Break.BuilderaddBreaksBuilder()

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Returns
Type	Description
`ShipmentRoute.Break.Builder`

addBreaksBuilder(int index)

publicShipmentRoute.Break.BuilderaddBreaksBuilder(intindex)

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Break.Builder`

addEndLoads(CapacityQuantity value) (deprecated)

publicShipmentRoute.BuilderaddEndLoads(CapacityQuantityvalue)

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Parameter
Name	Description
`value`	`CapacityQuantity`

Returns
Type	Description
`ShipmentRoute.Builder`

addEndLoads(CapacityQuantity.Builder builderForValue) (deprecated)

publicShipmentRoute.BuilderaddEndLoads(CapacityQuantity.BuilderbuilderForValue)

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Parameter
Name	Description
`builderForValue`	`CapacityQuantity.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

addEndLoads(int index, CapacityQuantity value) (deprecated)

publicShipmentRoute.BuilderaddEndLoads(intindex,CapacityQuantityvalue)

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Parameters
Name	Description
`index`	`int`
`value`	`CapacityQuantity`

Returns
Type	Description
`ShipmentRoute.Builder`

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

publicShipmentRoute.BuilderaddEndLoads(intindex,CapacityQuantity.BuilderbuilderForValue)

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`CapacityQuantity.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

addEndLoadsBuilder() (deprecated)

publicCapacityQuantity.BuilderaddEndLoadsBuilder()

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Returns
Type	Description
`CapacityQuantity.Builder`

addEndLoadsBuilder(int index) (deprecated)

publicCapacityQuantity.BuilderaddEndLoadsBuilder(intindex)

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CapacityQuantity.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicShipmentRoute.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ShipmentRoute.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addTransitions(ShipmentRoute.Transition value)

publicShipmentRoute.BuilderaddTransitions(ShipmentRoute.Transitionvalue)

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Parameter
Name	Description
`value`	`ShipmentRoute.Transition`

Returns
Type	Description
`ShipmentRoute.Builder`

addTransitions(ShipmentRoute.Transition.Builder builderForValue)

publicShipmentRoute.BuilderaddTransitions(ShipmentRoute.Transition.BuilderbuilderForValue)

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Parameter
Name	Description
`builderForValue`	`ShipmentRoute.Transition.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

addTransitions(int index, ShipmentRoute.Transition value)

publicShipmentRoute.BuilderaddTransitions(intindex,ShipmentRoute.Transitionvalue)

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Parameters
Name	Description
`index`	`int`
`value`	`ShipmentRoute.Transition`

Returns
Type	Description
`ShipmentRoute.Builder`

addTransitions(int index, ShipmentRoute.Transition.Builder builderForValue)

publicShipmentRoute.BuilderaddTransitions(intindex,ShipmentRoute.Transition.BuilderbuilderForValue)

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ShipmentRoute.Transition.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

addTransitionsBuilder()

publicShipmentRoute.Transition.BuilderaddTransitionsBuilder()

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Returns
Type	Description
`ShipmentRoute.Transition.Builder`

addTransitionsBuilder(int index)

publicShipmentRoute.Transition.BuilderaddTransitionsBuilder(intindex)

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Transition.Builder`

addTravelSteps(ShipmentRoute.TravelStep value) (deprecated)

publicShipmentRoute.BuilderaddTravelSteps(ShipmentRoute.TravelStepvalue)

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Parameter
Name	Description
`value`	`ShipmentRoute.TravelStep`

Returns
Type	Description
`ShipmentRoute.Builder`

addTravelSteps(ShipmentRoute.TravelStep.Builder builderForValue) (deprecated)

publicShipmentRoute.BuilderaddTravelSteps(ShipmentRoute.TravelStep.BuilderbuilderForValue)

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Parameter
Name	Description
`builderForValue`	`ShipmentRoute.TravelStep.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

addTravelSteps(int index, ShipmentRoute.TravelStep value) (deprecated)

publicShipmentRoute.BuilderaddTravelSteps(intindex,ShipmentRoute.TravelStepvalue)

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Parameters
Name	Description
`index`	`int`
`value`	`ShipmentRoute.TravelStep`

Returns
Type	Description
`ShipmentRoute.Builder`

addTravelSteps(int index, ShipmentRoute.TravelStep.Builder builderForValue) (deprecated)

publicShipmentRoute.BuilderaddTravelSteps(intindex,ShipmentRoute.TravelStep.BuilderbuilderForValue)

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ShipmentRoute.TravelStep.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

addTravelStepsBuilder() (deprecated)

publicShipmentRoute.TravelStep.BuilderaddTravelStepsBuilder()

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

addTravelStepsBuilder(int index) (deprecated)

publicShipmentRoute.TravelStep.BuilderaddTravelStepsBuilder(intindex)

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

addVisits(ShipmentRoute.Visit value)

publicShipmentRoute.BuilderaddVisits(ShipmentRoute.Visitvalue)

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Parameter
Name	Description
`value`	`ShipmentRoute.Visit`

Returns
Type	Description
`ShipmentRoute.Builder`

addVisits(ShipmentRoute.Visit.Builder builderForValue)

publicShipmentRoute.BuilderaddVisits(ShipmentRoute.Visit.BuilderbuilderForValue)

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Parameter
Name	Description
`builderForValue`	`ShipmentRoute.Visit.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

addVisits(int index, ShipmentRoute.Visit value)

publicShipmentRoute.BuilderaddVisits(intindex,ShipmentRoute.Visitvalue)

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Parameters
Name	Description
`index`	`int`
`value`	`ShipmentRoute.Visit`

Returns
Type	Description
`ShipmentRoute.Builder`

addVisits(int index, ShipmentRoute.Visit.Builder builderForValue)

publicShipmentRoute.BuilderaddVisits(intindex,ShipmentRoute.Visit.BuilderbuilderForValue)

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ShipmentRoute.Visit.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

addVisitsBuilder()

publicShipmentRoute.Visit.BuilderaddVisitsBuilder()

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Returns
Type	Description
`ShipmentRoute.Visit.Builder`

addVisitsBuilder(int index)

publicShipmentRoute.Visit.BuilderaddVisitsBuilder(intindex)

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Visit.Builder`

build()

publicShipmentRoutebuild()

Returns
Type	Description
`ShipmentRoute`

buildPartial()

publicShipmentRoutebuildPartial()

Returns
Type	Description
`ShipmentRoute`

clear()

publicShipmentRoute.Builderclear()

Returns
Type	Description
`ShipmentRoute.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBreaks()

publicShipmentRoute.BuilderclearBreaks()

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Returns
Type	Description
`ShipmentRoute.Builder`

clearDelayBeforeVehicleEnd() (deprecated)

publicShipmentRoute.BuilderclearDelayBeforeVehicleEnd()

Deprecated: Delay occurring before the vehicle end. See TransitionAttributes.delay.

.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];

Returns
Type	Description
`ShipmentRoute.Builder`

clearEndLoads() (deprecated)

publicShipmentRoute.BuilderclearEndLoads()

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Returns
Type	Description
`ShipmentRoute.Builder`

clearField(Descriptors.FieldDescriptor field)

publicShipmentRoute.BuilderclearField(Descriptors.FieldDescriptorfield)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`ShipmentRoute.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearHasTrafficInfeasibilities()

publicShipmentRoute.BuilderclearHasTrafficInfeasibilities()

When OptimizeToursRequest.consider_road_traffic, is set to true, this field indicates that inconsistencies in route timings are predicted using traffic-based travel duration estimates. There may be insufficient time to complete traffic-adjusted travel, delays, and breaks between visits, before the first visit, or after the last visit, while still satisfying the visit and vehicle time windows. For example,

`start_time(previous_visit) + duration(previous_visit) + travel_duration(previous_visit, next_visit) > start_time(next_visit)

Arrival at next_visit will likely happen later than its current time window due the increased estimate of travel timetravel_duration(previous_visit, next_visit)` due to traffic. Also, a break may be forced to overlap with a visit due to an increase in travel time estimates and visit or break time window restrictions.

bool has_traffic_infeasibilities = 9;

Returns
Type	Description
`ShipmentRoute.Builder`	This builder for chaining.

clearMetrics()

publicShipmentRoute.BuilderclearMetrics()

Duration, distance and load metrics for this route. The fields of AggregatedMetrics are summed over all ShipmentRoute.transitions or ShipmentRoute.visits, depending on the context.

.google.cloud.optimization.v1.AggregatedMetrics metrics = 12;

Returns
Type	Description
`ShipmentRoute.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

publicShipmentRoute.BuilderclearOneof(Descriptors.OneofDescriptoroneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`ShipmentRoute.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRouteCosts()

publicShipmentRoute.BuilderclearRouteCosts()

Returns
Type	Description
`ShipmentRoute.Builder`

clearRoutePolyline()

publicShipmentRoute.BuilderclearRoutePolyline()

The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true.

.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;

Returns
Type	Description
`ShipmentRoute.Builder`

clearRouteTotalCost()

publicShipmentRoute.BuilderclearRouteTotalCost()

Total cost of the route. The sum of all costs in the cost map.

double route_total_cost = 18;

Returns
Type	Description
`ShipmentRoute.Builder`	This builder for chaining.

clearTransitions()

publicShipmentRoute.BuilderclearTransitions()

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Returns
Type	Description
`ShipmentRoute.Builder`

clearTravelSteps() (deprecated)

publicShipmentRoute.BuilderclearTravelSteps()

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Returns
Type	Description
`ShipmentRoute.Builder`

clearVehicleDetour() (deprecated)

publicShipmentRoute.BuilderclearVehicleDetour()

Deprecated: No longer used. This field will only be populated at the ShipmentRoute.Visit level.

This field is the extra detour time due to the shipments visited on the route.

It is equal to vehicle_end_time - vehicle_start_time - travel duration from the vehicle's start_location to its end_location.

.google.protobuf.Duration vehicle_detour = 15 [deprecated = true];

Returns
Type	Description
`ShipmentRoute.Builder`

clearVehicleEndTime()

publicShipmentRoute.BuilderclearVehicleEndTime()

Time at which the vehicle finishes its route.

.google.protobuf.Timestamp vehicle_end_time = 6;

Returns
Type	Description
`ShipmentRoute.Builder`

clearVehicleIndex()

publicShipmentRoute.BuilderclearVehicleIndex()

Vehicle performing the route, identified by its index in the source ShipmentModel.

int32 vehicle_index = 1;

Returns
Type	Description
`ShipmentRoute.Builder`	This builder for chaining.

clearVehicleLabel()

publicShipmentRoute.BuilderclearVehicleLabel()

Label of the vehicle performing this route, equal to ShipmentModel.vehicles(vehicle_index).label, if specified.

string vehicle_label = 2;

Returns
Type	Description
`ShipmentRoute.Builder`	This builder for chaining.

clearVehicleStartTime()

publicShipmentRoute.BuilderclearVehicleStartTime()

Time at which the vehicle starts its route.

.google.protobuf.Timestamp vehicle_start_time = 5;

Returns
Type	Description
`ShipmentRoute.Builder`

clearVisits()

publicShipmentRoute.BuilderclearVisits()

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Returns
Type	Description
`ShipmentRoute.Builder`

clone()

publicShipmentRoute.Builderclone()

Returns
Type	Description
`ShipmentRoute.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsRouteCosts(String key)

publicbooleancontainsRouteCosts(Stringkey)

Cost of the route, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole route. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the route. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01.

map<string, double> route_costs = 17;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getBreaks(int index)

publicShipmentRoute.BreakgetBreaks(intindex)

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Break`

getBreaksBuilder(int index)

publicShipmentRoute.Break.BuildergetBreaksBuilder(intindex)

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Break.Builder`

getBreaksBuilderList()

publicList<ShipmentRoute.Break.Builder>getBreaksBuilderList()

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Returns
Type	Description
`List<Builder>`

getBreaksCount()

publicintgetBreaksCount()

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Returns
Type	Description
`int`

getBreaksList()

publicList<ShipmentRoute.Break>getBreaksList()

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Returns
Type	Description
`List<Break>`

getBreaksOrBuilder(int index)

publicShipmentRoute.BreakOrBuildergetBreaksOrBuilder(intindex)

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.BreakOrBuilder`

getBreaksOrBuilderList()

publicList<?extendsShipmentRoute.BreakOrBuilder>getBreaksOrBuilderList()

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Returns
Type	Description
`List<? extends com.google.cloud.optimization.v1.ShipmentRoute.BreakOrBuilder>`

getDefaultInstanceForType()

publicShipmentRoutegetDefaultInstanceForType()

Returns
Type	Description
`ShipmentRoute`

getDelayBeforeVehicleEnd() (deprecated)

publicShipmentRoute.DelaygetDelayBeforeVehicleEnd()

Deprecated. google.cloud.optimization.v1.ShipmentRoute.delay_before_vehicle_end is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=2219

Deprecated: Delay occurring before the vehicle end. See TransitionAttributes.delay.

.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];

Returns
Type	Description
`ShipmentRoute.Delay`	The delayBeforeVehicleEnd.

getDelayBeforeVehicleEndBuilder() (deprecated)

publicShipmentRoute.Delay.BuildergetDelayBeforeVehicleEndBuilder()

Deprecated: Delay occurring before the vehicle end. See TransitionAttributes.delay.

.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];

Returns
Type	Description
`ShipmentRoute.Delay.Builder`

getDelayBeforeVehicleEndOrBuilder() (deprecated)

publicShipmentRoute.DelayOrBuildergetDelayBeforeVehicleEndOrBuilder()

Deprecated: Delay occurring before the vehicle end. See TransitionAttributes.delay.

.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];

Returns
Type	Description
`ShipmentRoute.DelayOrBuilder`

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEndLoads(int index) (deprecated)

publicCapacityQuantitygetEndLoads(intindex)

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CapacityQuantity`

getEndLoadsBuilder(int index) (deprecated)

publicCapacityQuantity.BuildergetEndLoadsBuilder(intindex)

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CapacityQuantity.Builder`

getEndLoadsBuilderList() (deprecated)

publicList<CapacityQuantity.Builder>getEndLoadsBuilderList()

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Returns
Type	Description
`List<Builder>`

getEndLoadsCount() (deprecated)

publicintgetEndLoadsCount()

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Returns
Type	Description
`int`

getEndLoadsList() (deprecated)

publicList<CapacityQuantity>getEndLoadsList()

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Returns
Type	Description
`List<CapacityQuantity>`

getEndLoadsOrBuilder(int index) (deprecated)

publicCapacityQuantityOrBuildergetEndLoadsOrBuilder(intindex)

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`CapacityQuantityOrBuilder`

getEndLoadsOrBuilderList() (deprecated)

publicList<?extendsCapacityQuantityOrBuilder>getEndLoadsOrBuilderList()

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Returns
Type	Description
`List<? extends com.google.cloud.optimization.v1.CapacityQuantityOrBuilder>`

getHasTrafficInfeasibilities()

publicbooleangetHasTrafficInfeasibilities()

`start_time(previous_visit) + duration(previous_visit) + travel_duration(previous_visit, next_visit) > start_time(next_visit)

bool has_traffic_infeasibilities = 9;

Returns
Type	Description
`boolean`	The hasTrafficInfeasibilities.

getMetrics()

publicAggregatedMetricsgetMetrics()

Duration, distance and load metrics for this route. The fields of AggregatedMetrics are summed over all ShipmentRoute.transitions or ShipmentRoute.visits, depending on the context.

.google.cloud.optimization.v1.AggregatedMetrics metrics = 12;

Returns
Type	Description
`AggregatedMetrics`	The metrics.

getMetricsBuilder()

publicAggregatedMetrics.BuildergetMetricsBuilder()

Duration, distance and load metrics for this route. The fields of AggregatedMetrics are summed over all ShipmentRoute.transitions or ShipmentRoute.visits, depending on the context.

.google.cloud.optimization.v1.AggregatedMetrics metrics = 12;

Returns
Type	Description
`AggregatedMetrics.Builder`

getMetricsOrBuilder()

publicAggregatedMetricsOrBuildergetMetricsOrBuilder()

Duration, distance and load metrics for this route. The fields of AggregatedMetrics are summed over all ShipmentRoute.transitions or ShipmentRoute.visits, depending on the context.

.google.cloud.optimization.v1.AggregatedMetrics metrics = 12;

Returns
Type	Description
`AggregatedMetricsOrBuilder`

getMutableRouteCosts() (deprecated)

publicMap<String,Double>getMutableRouteCosts()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,Double>`

getRouteCosts() (deprecated)

publicMap<String,Double>getRouteCosts()

Use #getRouteCostsMap() instead.

Returns
Type	Description
`Map<String,Double>`

getRouteCostsCount()

publicintgetRouteCostsCount()

map<string, double> route_costs = 17;

Returns
Type	Description
`int`

getRouteCostsMap()

publicMap<String,Double>getRouteCostsMap()

map<string, double> route_costs = 17;

Returns
Type	Description
`Map<String,Double>`

getRouteCostsOrDefault(String key, double defaultValue)

publicdoublegetRouteCostsOrDefault(Stringkey,doubledefaultValue)

map<string, double> route_costs = 17;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`double`

Returns
Type	Description
`double`

getRouteCostsOrThrow(String key)

publicdoublegetRouteCostsOrThrow(Stringkey)

map<string, double> route_costs = 17;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`double`

getRoutePolyline()

publicShipmentRoute.EncodedPolylinegetRoutePolyline()

The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true.

.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;

Returns
Type	Description
`ShipmentRoute.EncodedPolyline`	The routePolyline.

getRoutePolylineBuilder()

publicShipmentRoute.EncodedPolyline.BuildergetRoutePolylineBuilder()

The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true.

.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;

Returns
Type	Description
`ShipmentRoute.EncodedPolyline.Builder`

getRoutePolylineOrBuilder()

publicShipmentRoute.EncodedPolylineOrBuildergetRoutePolylineOrBuilder()

The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true.

.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;

Returns
Type	Description
`ShipmentRoute.EncodedPolylineOrBuilder`

getRouteTotalCost()

publicdoublegetRouteTotalCost()

Total cost of the route. The sum of all costs in the cost map.

double route_total_cost = 18;

Returns
Type	Description
`double`	The routeTotalCost.

getTransitions(int index)

publicShipmentRoute.TransitiongetTransitions(intindex)

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Transition`

getTransitionsBuilder(int index)

publicShipmentRoute.Transition.BuildergetTransitionsBuilder(intindex)

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Transition.Builder`

getTransitionsBuilderList()

publicList<ShipmentRoute.Transition.Builder>getTransitionsBuilderList()

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Returns
Type	Description
`List<Builder>`

getTransitionsCount()

publicintgetTransitionsCount()

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Returns
Type	Description
`int`

getTransitionsList()

publicList<ShipmentRoute.Transition>getTransitionsList()

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Returns
Type	Description
`List<Transition>`

getTransitionsOrBuilder(int index)

publicShipmentRoute.TransitionOrBuildergetTransitionsOrBuilder(intindex)

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.TransitionOrBuilder`

getTransitionsOrBuilderList()

publicList<?extendsShipmentRoute.TransitionOrBuilder>getTransitionsOrBuilderList()

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Returns
Type	Description
`List<? extends com.google.cloud.optimization.v1.ShipmentRoute.TransitionOrBuilder>`

getTravelSteps(int index) (deprecated)

publicShipmentRoute.TravelStepgetTravelSteps(intindex)

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.TravelStep`

getTravelStepsBuilder(int index) (deprecated)

publicShipmentRoute.TravelStep.BuildergetTravelStepsBuilder(intindex)

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.TravelStep.Builder`

getTravelStepsBuilderList() (deprecated)

publicList<ShipmentRoute.TravelStep.Builder>getTravelStepsBuilderList()

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Returns
Type	Description
`List<Builder>`

getTravelStepsCount() (deprecated)

publicintgetTravelStepsCount()

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Returns
Type	Description
`int`

getTravelStepsList() (deprecated)

publicList<ShipmentRoute.TravelStep>getTravelStepsList()

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Returns
Type	Description
`List<TravelStep>`

getTravelStepsOrBuilder(int index) (deprecated)

publicShipmentRoute.TravelStepOrBuildergetTravelStepsOrBuilder(intindex)

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.TravelStepOrBuilder`

getTravelStepsOrBuilderList() (deprecated)

publicList<?extendsShipmentRoute.TravelStepOrBuilder>getTravelStepsOrBuilderList()

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Returns
Type	Description
`List<? extends com.google.cloud.optimization.v1.ShipmentRoute.TravelStepOrBuilder>`

getVehicleDetour() (deprecated)

publicDurationgetVehicleDetour()

Deprecated. google.cloud.optimization.v1.ShipmentRoute.vehicle_detour is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=2215

Deprecated: No longer used. This field will only be populated at the ShipmentRoute.Visit level.

This field is the extra detour time due to the shipments visited on the route.

It is equal to vehicle_end_time - vehicle_start_time - travel duration from the vehicle's start_location to its end_location.

.google.protobuf.Duration vehicle_detour = 15 [deprecated = true];

Returns
Type	Description
`Duration`	The vehicleDetour.

getVehicleDetourBuilder() (deprecated)

publicDuration.BuildergetVehicleDetourBuilder()

Deprecated: No longer used. This field will only be populated at the ShipmentRoute.Visit level.

This field is the extra detour time due to the shipments visited on the route.

It is equal to vehicle_end_time - vehicle_start_time - travel duration from the vehicle's start_location to its end_location.

.google.protobuf.Duration vehicle_detour = 15 [deprecated = true];

Returns
Type	Description
`Builder`

getVehicleDetourOrBuilder() (deprecated)

publicDurationOrBuildergetVehicleDetourOrBuilder()

Deprecated: No longer used. This field will only be populated at the ShipmentRoute.Visit level.

This field is the extra detour time due to the shipments visited on the route.

It is equal to vehicle_end_time - vehicle_start_time - travel duration from the vehicle's start_location to its end_location.

.google.protobuf.Duration vehicle_detour = 15 [deprecated = true];

Returns
Type	Description
`DurationOrBuilder`

getVehicleEndTime()

publicTimestampgetVehicleEndTime()

Time at which the vehicle finishes its route.

.google.protobuf.Timestamp vehicle_end_time = 6;

Returns
Type	Description
`Timestamp`	The vehicleEndTime.

getVehicleEndTimeBuilder()

publicTimestamp.BuildergetVehicleEndTimeBuilder()

Time at which the vehicle finishes its route.

.google.protobuf.Timestamp vehicle_end_time = 6;

Returns
Type	Description
`Builder`

getVehicleEndTimeOrBuilder()

publicTimestampOrBuildergetVehicleEndTimeOrBuilder()

Time at which the vehicle finishes its route.

.google.protobuf.Timestamp vehicle_end_time = 6;

Returns
Type	Description
`TimestampOrBuilder`

getVehicleIndex()

publicintgetVehicleIndex()

Vehicle performing the route, identified by its index in the source ShipmentModel.

int32 vehicle_index = 1;

Returns
Type	Description
`int`	The vehicleIndex.

getVehicleLabel()

publicStringgetVehicleLabel()

Label of the vehicle performing this route, equal to ShipmentModel.vehicles(vehicle_index).label, if specified.

string vehicle_label = 2;

Returns
Type	Description
`String`	The vehicleLabel.

getVehicleLabelBytes()

publicByteStringgetVehicleLabelBytes()

Label of the vehicle performing this route, equal to ShipmentModel.vehicles(vehicle_index).label, if specified.

string vehicle_label = 2;

Returns
Type	Description
`ByteString`	The bytes for vehicleLabel.

getVehicleStartTime()

publicTimestampgetVehicleStartTime()

Time at which the vehicle starts its route.

.google.protobuf.Timestamp vehicle_start_time = 5;

Returns
Type	Description
`Timestamp`	The vehicleStartTime.

getVehicleStartTimeBuilder()

publicTimestamp.BuildergetVehicleStartTimeBuilder()

Time at which the vehicle starts its route.

.google.protobuf.Timestamp vehicle_start_time = 5;

Returns
Type	Description
`Builder`

getVehicleStartTimeOrBuilder()

publicTimestampOrBuildergetVehicleStartTimeOrBuilder()

Time at which the vehicle starts its route.

.google.protobuf.Timestamp vehicle_start_time = 5;

Returns
Type	Description
`TimestampOrBuilder`

getVisits(int index)

publicShipmentRoute.VisitgetVisits(intindex)

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Visit`

getVisitsBuilder(int index)

publicShipmentRoute.Visit.BuildergetVisitsBuilder(intindex)

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Visit.Builder`

getVisitsBuilderList()

publicList<ShipmentRoute.Visit.Builder>getVisitsBuilderList()

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Returns
Type	Description
`List<Builder>`

getVisitsCount()

publicintgetVisitsCount()

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Returns
Type	Description
`int`

getVisitsList()

publicList<ShipmentRoute.Visit>getVisitsList()

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Returns
Type	Description
`List<Visit>`

getVisitsOrBuilder(int index)

publicShipmentRoute.VisitOrBuildergetVisitsOrBuilder(intindex)

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.VisitOrBuilder`

getVisitsOrBuilderList()

publicList<?extendsShipmentRoute.VisitOrBuilder>getVisitsOrBuilderList()

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Returns
Type	Description
`List<? extends com.google.cloud.optimization.v1.ShipmentRoute.VisitOrBuilder>`

hasDelayBeforeVehicleEnd() (deprecated)

publicbooleanhasDelayBeforeVehicleEnd()

Deprecated. google.cloud.optimization.v1.ShipmentRoute.delay_before_vehicle_end is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=2219

Deprecated: Delay occurring before the vehicle end. See TransitionAttributes.delay.

.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];

Returns
Type	Description
`boolean`	Whether the delayBeforeVehicleEnd field is set.

hasMetrics()

publicbooleanhasMetrics()

Duration, distance and load metrics for this route. The fields of AggregatedMetrics are summed over all ShipmentRoute.transitions or ShipmentRoute.visits, depending on the context.

.google.cloud.optimization.v1.AggregatedMetrics metrics = 12;

Returns
Type	Description
`boolean`	Whether the metrics field is set.

hasRoutePolyline()

publicbooleanhasRoutePolyline()

The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true.

.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;

Returns
Type	Description
`boolean`	Whether the routePolyline field is set.

hasVehicleDetour() (deprecated)

publicbooleanhasVehicleDetour()

Deprecated. google.cloud.optimization.v1.ShipmentRoute.vehicle_detour is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=2215

Deprecated: No longer used. This field will only be populated at the ShipmentRoute.Visit level.

This field is the extra detour time due to the shipments visited on the route.

It is equal to vehicle_end_time - vehicle_start_time - travel duration from the vehicle's start_location to its end_location.

.google.protobuf.Duration vehicle_detour = 15 [deprecated = true];

Returns
Type	Description
`boolean`	Whether the vehicleDetour field is set.

hasVehicleEndTime()

publicbooleanhasVehicleEndTime()

Time at which the vehicle finishes its route.

.google.protobuf.Timestamp vehicle_end_time = 6;

Returns
Type	Description
`boolean`	Whether the vehicleEndTime field is set.

hasVehicleStartTime()

publicbooleanhasVehicleStartTime()

Time at which the vehicle starts its route.

.google.protobuf.Timestamp vehicle_start_time = 5;

Returns
Type	Description
`boolean`	Whether the vehicleStartTime field is set.

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protectedMapFieldReflectionAccessorinternalGetMutableMapFieldReflection(intnumber)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

publicfinalbooleanisInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeDelayBeforeVehicleEnd(ShipmentRoute.Delay value) (deprecated)

publicShipmentRoute.BuildermergeDelayBeforeVehicleEnd(ShipmentRoute.Delayvalue)

Deprecated: Delay occurring before the vehicle end. See TransitionAttributes.delay.

.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];

Parameter
Name	Description
`value`	`ShipmentRoute.Delay`

Returns
Type	Description
`ShipmentRoute.Builder`

mergeFrom(ShipmentRoute other)

publicShipmentRoute.BuildermergeFrom(ShipmentRouteother)

Parameter
Name	Description
`other`	`ShipmentRoute`

Returns
Type	Description
`ShipmentRoute.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicShipmentRoute.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ShipmentRoute.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

publicShipmentRoute.BuildermergeFrom(Messageother)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ShipmentRoute.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeMetrics(AggregatedMetrics value)

publicShipmentRoute.BuildermergeMetrics(AggregatedMetricsvalue)

Duration, distance and load metrics for this route. The fields of AggregatedMetrics are summed over all ShipmentRoute.transitions or ShipmentRoute.visits, depending on the context.

.google.cloud.optimization.v1.AggregatedMetrics metrics = 12;

Parameter
Name	Description
`value`	`AggregatedMetrics`

Returns
Type	Description
`ShipmentRoute.Builder`

mergeRoutePolyline(ShipmentRoute.EncodedPolyline value)

publicShipmentRoute.BuildermergeRoutePolyline(ShipmentRoute.EncodedPolylinevalue)

The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true.

.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;

Parameter
Name	Description
`value`	`ShipmentRoute.EncodedPolyline`

Returns
Type	Description
`ShipmentRoute.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalShipmentRoute.BuildermergeUnknownFields(UnknownFieldSetunknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ShipmentRoute.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeVehicleDetour(Duration value) (deprecated)

publicShipmentRoute.BuildermergeVehicleDetour(Durationvalue)

Deprecated: No longer used. This field will only be populated at the ShipmentRoute.Visit level.

This field is the extra detour time due to the shipments visited on the route.

It is equal to vehicle_end_time - vehicle_start_time - travel duration from the vehicle's start_location to its end_location.

.google.protobuf.Duration vehicle_detour = 15 [deprecated = true];

Parameter
Name	Description
`value`	`Duration`

Returns
Type	Description
`ShipmentRoute.Builder`

mergeVehicleEndTime(Timestamp value)

publicShipmentRoute.BuildermergeVehicleEndTime(Timestampvalue)

Time at which the vehicle finishes its route.

.google.protobuf.Timestamp vehicle_end_time = 6;

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`ShipmentRoute.Builder`

mergeVehicleStartTime(Timestamp value)

publicShipmentRoute.BuildermergeVehicleStartTime(Timestampvalue)

Time at which the vehicle starts its route.

.google.protobuf.Timestamp vehicle_start_time = 5;

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`ShipmentRoute.Builder`

putAllRouteCosts(Map<String,Double> values)

publicShipmentRoute.BuilderputAllRouteCosts(Map<String,Double>values)

map<string, double> route_costs = 17;

Parameter
Name	Description
`values`	`Map<String,Double>`

Returns
Type	Description
`ShipmentRoute.Builder`

putRouteCosts(String key, double value)

publicShipmentRoute.BuilderputRouteCosts(Stringkey,doublevalue)

map<string, double> route_costs = 17;

Parameters
Name	Description
`key`	`String`
`value`	`double`

Returns
Type	Description
`ShipmentRoute.Builder`

removeBreaks(int index)

publicShipmentRoute.BuilderremoveBreaks(intindex)

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Builder`

removeEndLoads(int index) (deprecated)

publicShipmentRoute.BuilderremoveEndLoads(intindex)

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Builder`

removeRouteCosts(String key)

publicShipmentRoute.BuilderremoveRouteCosts(Stringkey)

map<string, double> route_costs = 17;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`ShipmentRoute.Builder`

removeTransitions(int index)

publicShipmentRoute.BuilderremoveTransitions(intindex)

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Builder`

removeTravelSteps(int index) (deprecated)

publicShipmentRoute.BuilderremoveTravelSteps(intindex)

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Builder`

removeVisits(int index)

publicShipmentRoute.BuilderremoveVisits(intindex)

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ShipmentRoute.Builder`

setBreaks(int index, ShipmentRoute.Break value)

publicShipmentRoute.BuildersetBreaks(intindex,ShipmentRoute.Breakvalue)

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Parameters
Name	Description
`index`	`int`
`value`	`ShipmentRoute.Break`

Returns
Type	Description
`ShipmentRoute.Builder`

setBreaks(int index, ShipmentRoute.Break.Builder builderForValue)

publicShipmentRoute.BuildersetBreaks(intindex,ShipmentRoute.Break.BuilderbuilderForValue)

Breaks scheduled for the vehicle performing this route. The breaks sequence represents time intervals, each starting at the corresponding start_time and lasting duration seconds.

repeated .google.cloud.optimization.v1.ShipmentRoute.Break breaks = 11;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ShipmentRoute.Break.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

setDelayBeforeVehicleEnd(ShipmentRoute.Delay value) (deprecated)

publicShipmentRoute.BuildersetDelayBeforeVehicleEnd(ShipmentRoute.Delayvalue)

Deprecated: Delay occurring before the vehicle end. See TransitionAttributes.delay.

.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];

Parameter
Name	Description
`value`	`ShipmentRoute.Delay`

Returns
Type	Description
`ShipmentRoute.Builder`

setDelayBeforeVehicleEnd(ShipmentRoute.Delay.Builder builderForValue) (deprecated)

publicShipmentRoute.BuildersetDelayBeforeVehicleEnd(ShipmentRoute.Delay.BuilderbuilderForValue)

Deprecated: Delay occurring before the vehicle end. See TransitionAttributes.delay.

.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];

Parameter
Name	Description
`builderForValue`	`ShipmentRoute.Delay.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

setEndLoads(int index, CapacityQuantity value) (deprecated)

publicShipmentRoute.BuildersetEndLoads(intindex,CapacityQuantityvalue)

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Parameters
Name	Description
`index`	`int`
`value`	`CapacityQuantity`

Returns
Type	Description
`ShipmentRoute.Builder`

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

publicShipmentRoute.BuildersetEndLoads(intindex,CapacityQuantity.BuilderbuilderForValue)

repeated .google.cloud.optimization.v1.CapacityQuantity end_loads = 13 [deprecated = true];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`CapacityQuantity.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

publicShipmentRoute.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ShipmentRoute.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setHasTrafficInfeasibilities(boolean value)

publicShipmentRoute.BuildersetHasTrafficInfeasibilities(booleanvalue)

`start_time(previous_visit) + duration(previous_visit) + travel_duration(previous_visit, next_visit) > start_time(next_visit)

bool has_traffic_infeasibilities = 9;

Parameter
Name	Description
`value`	`boolean` The hasTrafficInfeasibilities to set.

Returns
Type	Description
`ShipmentRoute.Builder`	This builder for chaining.

setMetrics(AggregatedMetrics value)

publicShipmentRoute.BuildersetMetrics(AggregatedMetricsvalue)

Duration, distance and load metrics for this route. The fields of AggregatedMetrics are summed over all ShipmentRoute.transitions or ShipmentRoute.visits, depending on the context.

.google.cloud.optimization.v1.AggregatedMetrics metrics = 12;

Parameter
Name	Description
`value`	`AggregatedMetrics`

Returns
Type	Description
`ShipmentRoute.Builder`

setMetrics(AggregatedMetrics.Builder builderForValue)

publicShipmentRoute.BuildersetMetrics(AggregatedMetrics.BuilderbuilderForValue)

Duration, distance and load metrics for this route. The fields of AggregatedMetrics are summed over all ShipmentRoute.transitions or ShipmentRoute.visits, depending on the context.

.google.cloud.optimization.v1.AggregatedMetrics metrics = 12;

Parameter
Name	Description
`builderForValue`	`AggregatedMetrics.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

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

publicShipmentRoute.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`ShipmentRoute.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRoutePolyline(ShipmentRoute.EncodedPolyline value)

publicShipmentRoute.BuildersetRoutePolyline(ShipmentRoute.EncodedPolylinevalue)

The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true.

.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;

Parameter
Name	Description
`value`	`ShipmentRoute.EncodedPolyline`

Returns
Type	Description
`ShipmentRoute.Builder`

setRoutePolyline(ShipmentRoute.EncodedPolyline.Builder builderForValue)

publicShipmentRoute.BuildersetRoutePolyline(ShipmentRoute.EncodedPolyline.BuilderbuilderForValue)

The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true.

.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;

Parameter
Name	Description
`builderForValue`	`ShipmentRoute.EncodedPolyline.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

setRouteTotalCost(double value)

publicShipmentRoute.BuildersetRouteTotalCost(doublevalue)

Total cost of the route. The sum of all costs in the cost map.

double route_total_cost = 18;

Parameter
Name	Description
`value`	`double` The routeTotalCost to set.

Returns
Type	Description
`ShipmentRoute.Builder`	This builder for chaining.

setTransitions(int index, ShipmentRoute.Transition value)

publicShipmentRoute.BuildersetTransitions(intindex,ShipmentRoute.Transitionvalue)

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Parameters
Name	Description
`index`	`int`
`value`	`ShipmentRoute.Transition`

Returns
Type	Description
`ShipmentRoute.Builder`

setTransitions(int index, ShipmentRoute.Transition.Builder builderForValue)

publicShipmentRoute.BuildersetTransitions(intindex,ShipmentRoute.Transition.BuilderbuilderForValue)

Ordered list of transitions for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ShipmentRoute.Transition.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

setTravelSteps(int index, ShipmentRoute.TravelStep value) (deprecated)

publicShipmentRoute.BuildersetTravelSteps(intindex,ShipmentRoute.TravelStepvalue)

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Parameters
Name	Description
`index`	`int`
`value`	`ShipmentRoute.TravelStep`

Returns
Type	Description
`ShipmentRoute.Builder`

setTravelSteps(int index, ShipmentRoute.TravelStep.Builder builderForValue) (deprecated)

publicShipmentRoute.BuildersetTravelSteps(intindex,ShipmentRoute.TravelStep.BuilderbuilderForValue)

Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route.

repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ShipmentRoute.TravelStep.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalShipmentRoute.BuildersetUnknownFields(UnknownFieldSetunknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ShipmentRoute.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setVehicleDetour(Duration value) (deprecated)

publicShipmentRoute.BuildersetVehicleDetour(Durationvalue)

Deprecated: No longer used. This field will only be populated at the ShipmentRoute.Visit level.

This field is the extra detour time due to the shipments visited on the route.

It is equal to vehicle_end_time - vehicle_start_time - travel duration from the vehicle's start_location to its end_location.

.google.protobuf.Duration vehicle_detour = 15 [deprecated = true];

Parameter
Name	Description
`value`	`Duration`

Returns
Type	Description
`ShipmentRoute.Builder`

setVehicleDetour(Duration.Builder builderForValue) (deprecated)

publicShipmentRoute.BuildersetVehicleDetour(Duration.BuilderbuilderForValue)

Deprecated: No longer used. This field will only be populated at the ShipmentRoute.Visit level.

This field is the extra detour time due to the shipments visited on the route.

It is equal to vehicle_end_time - vehicle_start_time - travel duration from the vehicle's start_location to its end_location.

.google.protobuf.Duration vehicle_detour = 15 [deprecated = true];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

setVehicleEndTime(Timestamp value)

publicShipmentRoute.BuildersetVehicleEndTime(Timestampvalue)

Time at which the vehicle finishes its route.

.google.protobuf.Timestamp vehicle_end_time = 6;

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`ShipmentRoute.Builder`

setVehicleEndTime(Timestamp.Builder builderForValue)

publicShipmentRoute.BuildersetVehicleEndTime(Timestamp.BuilderbuilderForValue)

Time at which the vehicle finishes its route.

.google.protobuf.Timestamp vehicle_end_time = 6;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

setVehicleIndex(int value)

publicShipmentRoute.BuildersetVehicleIndex(intvalue)

Vehicle performing the route, identified by its index in the source ShipmentModel.

int32 vehicle_index = 1;

Parameter
Name	Description
`value`	`int` The vehicleIndex to set.

Returns
Type	Description
`ShipmentRoute.Builder`	This builder for chaining.

setVehicleLabel(String value)

publicShipmentRoute.BuildersetVehicleLabel(Stringvalue)

Label of the vehicle performing this route, equal to ShipmentModel.vehicles(vehicle_index).label, if specified.

string vehicle_label = 2;

Parameter
Name	Description
`value`	`String` The vehicleLabel to set.

Returns
Type	Description
`ShipmentRoute.Builder`	This builder for chaining.

setVehicleLabelBytes(ByteString value)

publicShipmentRoute.BuildersetVehicleLabelBytes(ByteStringvalue)

Label of the vehicle performing this route, equal to ShipmentModel.vehicles(vehicle_index).label, if specified.

string vehicle_label = 2;

Parameter
Name	Description
`value`	`ByteString` The bytes for vehicleLabel to set.

Returns
Type	Description
`ShipmentRoute.Builder`	This builder for chaining.

setVehicleStartTime(Timestamp value)

publicShipmentRoute.BuildersetVehicleStartTime(Timestampvalue)

Time at which the vehicle starts its route.

.google.protobuf.Timestamp vehicle_start_time = 5;

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`ShipmentRoute.Builder`

setVehicleStartTime(Timestamp.Builder builderForValue)

publicShipmentRoute.BuildersetVehicleStartTime(Timestamp.BuilderbuilderForValue)

Time at which the vehicle starts its route.

.google.protobuf.Timestamp vehicle_start_time = 5;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

setVisits(int index, ShipmentRoute.Visit value)

publicShipmentRoute.BuildersetVisits(intindex,ShipmentRoute.Visitvalue)

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Parameters
Name	Description
`index`	`int`
`value`	`ShipmentRoute.Visit`

Returns
Type	Description
`ShipmentRoute.Builder`

setVisits(int index, ShipmentRoute.Visit.Builder builderForValue)

publicShipmentRoute.BuildersetVisits(intindex,ShipmentRoute.Visit.BuilderbuilderForValue)

Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused.

repeated .google.cloud.optimization.v1.ShipmentRoute.Visit visits = 7;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ShipmentRoute.Visit.Builder`

Returns
Type	Description
`ShipmentRoute.Builder`

Class ShipmentRoute.Builder (1.35.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Static Methods

getDescriptor()

Methods

addAllBreaks(Iterable<? extends ShipmentRoute.Break> values)

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

addAllTransitions(Iterable<? extends ShipmentRoute.Transition> values)

addAllTravelSteps(Iterable<? extends ShipmentRoute.TravelStep> values) (deprecated)

addAllVisits(Iterable<? extends ShipmentRoute.Visit> values)

addBreaks(ShipmentRoute.Break value)

addBreaks(ShipmentRoute.Break.Builder builderForValue)

addBreaks(int index, ShipmentRoute.Break value)

addBreaks(int index, ShipmentRoute.Break.Builder builderForValue)

addBreaksBuilder()

addBreaksBuilder(int index)

addEndLoads(CapacityQuantity value) (deprecated)

addEndLoads(CapacityQuantity.Builder builderForValue) (deprecated)

addEndLoads(int index, CapacityQuantity value) (deprecated)

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

addEndLoadsBuilder() (deprecated)

addEndLoadsBuilder(int index) (deprecated)

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addTransitions(ShipmentRoute.Transition value)

addTransitions(ShipmentRoute.Transition.Builder builderForValue)

addTransitions(int index, ShipmentRoute.Transition value)

addTransitions(int index, ShipmentRoute.Transition.Builder builderForValue)

addTransitionsBuilder()

addTransitionsBuilder(int index)

addTravelSteps(ShipmentRoute.TravelStep value) (deprecated)

addTravelSteps(ShipmentRoute.TravelStep.Builder builderForValue) (deprecated)

addTravelSteps(int index, ShipmentRoute.TravelStep value) (deprecated)

addTravelSteps(int index, ShipmentRoute.TravelStep.Builder builderForValue) (deprecated)

addTravelStepsBuilder() (deprecated)

addTravelStepsBuilder(int index) (deprecated)

addVisits(ShipmentRoute.Visit value)

addVisits(ShipmentRoute.Visit.Builder builderForValue)

addVisits(int index, ShipmentRoute.Visit value)

addVisits(int index, ShipmentRoute.Visit.Builder builderForValue)

addVisitsBuilder()

addVisitsBuilder(int index)

build()

buildPartial()

clear()

clearBreaks()

clearDelayBeforeVehicleEnd() (deprecated)

clearEndLoads() (deprecated)

clearField(Descriptors.FieldDescriptor field)

clearHasTrafficInfeasibilities()

clearMetrics()

clearOneof(Descriptors.OneofDescriptor oneof)

clearRouteCosts()

clearRoutePolyline()

clearRouteTotalCost()

clearTransitions()

clearTravelSteps() (deprecated)

clearVehicleDetour() (deprecated)

clearVehicleEndTime()

clearVehicleIndex()

clearVehicleLabel()

clearVehicleStartTime()

clearVisits()

clone()

containsRouteCosts(String key)

getBreaks(int index)

getBreaksBuilder(int index)

getBreaksBuilderList()

getBreaksCount()

getBreaksList()

getBreaksOrBuilder(int index)

getBreaksOrBuilderList()

getDefaultInstanceForType()

getDelayBeforeVehicleEnd() (deprecated)

getDelayBeforeVehicleEndBuilder() (deprecated)

getDelayBeforeVehicleEndOrBuilder() (deprecated)

getDescriptorForType()

getEndLoads(int index) (deprecated)

getEndLoadsBuilder(int index) (deprecated)

Class ShipmentRoute.Builder (1.35.0)