Class ShipmentRoute.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ShipmentRoute.Builder>
com.google.cloud.optimization.v1.ShipmentRoute.Builder
All Implemented Interfaces:
ShipmentRouteOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ShipmentRoute

public static final class ShipmentRoute.Builder extends com.google.protobuf.GeneratedMessage.Builder<ShipmentRoute.Builder> implements ShipmentRouteOrBuilder
 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     end
 ```
 Note 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
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<ShipmentRoute.Builder>
    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<ShipmentRoute.Builder>
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ShipmentRoute.Builder>
    • clear

      public ShipmentRoute.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ShipmentRoute.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ShipmentRoute.Builder>
    • getDefaultInstanceForType

      public ShipmentRoute getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public ShipmentRoute build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public ShipmentRoute buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public ShipmentRoute.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ShipmentRoute.Builder>
    • mergeFrom

      public ShipmentRoute.Builder mergeFrom(ShipmentRoute other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ShipmentRoute.Builder>
    • mergeFrom

      public ShipmentRoute.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ShipmentRoute.Builder>
      Throws:
      IOException
    • getVehicleIndex

      public int getVehicleIndex()
       Vehicle performing the route, identified by its index in the source
       `ShipmentModel`.
       
      int32 vehicle_index = 1;
      Specified by:
      getVehicleIndex in interface ShipmentRouteOrBuilder
      Returns:
      The vehicleIndex.
    • setVehicleIndex

      public ShipmentRoute.Builder setVehicleIndex(int value)
       Vehicle performing the route, identified by its index in the source
       `ShipmentModel`.
       
      int32 vehicle_index = 1;
      Parameters:
      value - The vehicleIndex to set.
      Returns:
      This builder for chaining.
    • clearVehicleIndex

      public ShipmentRoute.Builder clearVehicleIndex()
       Vehicle performing the route, identified by its index in the source
       `ShipmentModel`.
       
      int32 vehicle_index = 1;
      Returns:
      This builder for chaining.
    • getVehicleLabel

      public String getVehicleLabel()
       Label of the vehicle performing this route, equal to
       `ShipmentModel.vehicles(vehicle_index).label`, if specified.
       
      string vehicle_label = 2;
      Specified by:
      getVehicleLabel in interface ShipmentRouteOrBuilder
      Returns:
      The vehicleLabel.
    • getVehicleLabelBytes

      public com.google.protobuf.ByteString getVehicleLabelBytes()
       Label of the vehicle performing this route, equal to
       `ShipmentModel.vehicles(vehicle_index).label`, if specified.
       
      string vehicle_label = 2;
      Specified by:
      getVehicleLabelBytes in interface ShipmentRouteOrBuilder
      Returns:
      The bytes for vehicleLabel.
    • setVehicleLabel

      public ShipmentRoute.Builder setVehicleLabel(String value)
       Label of the vehicle performing this route, equal to
       `ShipmentModel.vehicles(vehicle_index).label`, if specified.
       
      string vehicle_label = 2;
      Parameters:
      value - The vehicleLabel to set.
      Returns:
      This builder for chaining.
    • clearVehicleLabel

      public ShipmentRoute.Builder clearVehicleLabel()
       Label of the vehicle performing this route, equal to
       `ShipmentModel.vehicles(vehicle_index).label`, if specified.
       
      string vehicle_label = 2;
      Returns:
      This builder for chaining.
    • setVehicleLabelBytes

      public ShipmentRoute.Builder setVehicleLabelBytes(com.google.protobuf.ByteString value)
       Label of the vehicle performing this route, equal to
       `ShipmentModel.vehicles(vehicle_index).label`, if specified.
       
      string vehicle_label = 2;
      Parameters:
      value - The bytes for vehicleLabel to set.
      Returns:
      This builder for chaining.
    • hasVehicleStartTime

      public boolean hasVehicleStartTime()
       Time at which the vehicle starts its route.
       
      .google.protobuf.Timestamp vehicle_start_time = 5;
      Specified by:
      hasVehicleStartTime in interface ShipmentRouteOrBuilder
      Returns:
      Whether the vehicleStartTime field is set.
    • getVehicleStartTime

      public com.google.protobuf.Timestamp getVehicleStartTime()
       Time at which the vehicle starts its route.
       
      .google.protobuf.Timestamp vehicle_start_time = 5;
      Specified by:
      getVehicleStartTime in interface ShipmentRouteOrBuilder
      Returns:
      The vehicleStartTime.
    • setVehicleStartTime

      public ShipmentRoute.Builder setVehicleStartTime(com.google.protobuf.Timestamp value)
       Time at which the vehicle starts its route.
       
      .google.protobuf.Timestamp vehicle_start_time = 5;
    • setVehicleStartTime

      public ShipmentRoute.Builder setVehicleStartTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Time at which the vehicle starts its route.
       
      .google.protobuf.Timestamp vehicle_start_time = 5;
    • mergeVehicleStartTime

      public ShipmentRoute.Builder mergeVehicleStartTime(com.google.protobuf.Timestamp value)
       Time at which the vehicle starts its route.
       
      .google.protobuf.Timestamp vehicle_start_time = 5;
    • clearVehicleStartTime

      public ShipmentRoute.Builder clearVehicleStartTime()
       Time at which the vehicle starts its route.
       
      .google.protobuf.Timestamp vehicle_start_time = 5;
    • getVehicleStartTimeBuilder

      public com.google.protobuf.Timestamp.Builder getVehicleStartTimeBuilder()
       Time at which the vehicle starts its route.
       
      .google.protobuf.Timestamp vehicle_start_time = 5;
    • getVehicleStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getVehicleStartTimeOrBuilder()
       Time at which the vehicle starts its route.
       
      .google.protobuf.Timestamp vehicle_start_time = 5;
      Specified by:
      getVehicleStartTimeOrBuilder in interface ShipmentRouteOrBuilder
    • hasVehicleEndTime

      public boolean hasVehicleEndTime()
       Time at which the vehicle finishes its route.
       
      .google.protobuf.Timestamp vehicle_end_time = 6;
      Specified by:
      hasVehicleEndTime in interface ShipmentRouteOrBuilder
      Returns:
      Whether the vehicleEndTime field is set.
    • getVehicleEndTime

      public com.google.protobuf.Timestamp getVehicleEndTime()
       Time at which the vehicle finishes its route.
       
      .google.protobuf.Timestamp vehicle_end_time = 6;
      Specified by:
      getVehicleEndTime in interface ShipmentRouteOrBuilder
      Returns:
      The vehicleEndTime.
    • setVehicleEndTime

      public ShipmentRoute.Builder setVehicleEndTime(com.google.protobuf.Timestamp value)
       Time at which the vehicle finishes its route.
       
      .google.protobuf.Timestamp vehicle_end_time = 6;
    • setVehicleEndTime

      public ShipmentRoute.Builder setVehicleEndTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Time at which the vehicle finishes its route.
       
      .google.protobuf.Timestamp vehicle_end_time = 6;
    • mergeVehicleEndTime

      public ShipmentRoute.Builder mergeVehicleEndTime(com.google.protobuf.Timestamp value)
       Time at which the vehicle finishes its route.
       
      .google.protobuf.Timestamp vehicle_end_time = 6;
    • clearVehicleEndTime

      public ShipmentRoute.Builder clearVehicleEndTime()
       Time at which the vehicle finishes its route.
       
      .google.protobuf.Timestamp vehicle_end_time = 6;
    • getVehicleEndTimeBuilder

      public com.google.protobuf.Timestamp.Builder getVehicleEndTimeBuilder()
       Time at which the vehicle finishes its route.
       
      .google.protobuf.Timestamp vehicle_end_time = 6;
    • getVehicleEndTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getVehicleEndTimeOrBuilder()
       Time at which the vehicle finishes its route.
       
      .google.protobuf.Timestamp vehicle_end_time = 6;
      Specified by:
      getVehicleEndTimeOrBuilder in interface ShipmentRouteOrBuilder
    • getVisitsList

      public List<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;
      Specified by:
      getVisitsList in interface ShipmentRouteOrBuilder
    • getVisitsCount

      public int getVisitsCount()
       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;
      Specified by:
      getVisitsCount in interface ShipmentRouteOrBuilder
    • getVisits

      public ShipmentRoute.Visit getVisits(int index)
       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;
      Specified by:
      getVisits in interface ShipmentRouteOrBuilder
    • setVisits

      public ShipmentRoute.Builder setVisits(int index, ShipmentRoute.Visit value)
       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;
    • setVisits

      public ShipmentRoute.Builder setVisits(int index, ShipmentRoute.Visit.Builder builderForValue)
       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;
    • addVisits

      public ShipmentRoute.Builder addVisits(ShipmentRoute.Visit value)
       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;
    • addVisits

      public ShipmentRoute.Builder addVisits(int index, ShipmentRoute.Visit value)
       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;
    • addVisits

      public ShipmentRoute.Builder addVisits(ShipmentRoute.Visit.Builder builderForValue)
       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;
    • addVisits

      public ShipmentRoute.Builder addVisits(int index, ShipmentRoute.Visit.Builder builderForValue)
       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;
    • addAllVisits

      public ShipmentRoute.Builder addAllVisits(Iterable<? extends ShipmentRoute.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;
    • clearVisits

      public ShipmentRoute.Builder clearVisits()
       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;
    • removeVisits

      public ShipmentRoute.Builder removeVisits(int index)
       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;
    • getVisitsBuilder

      public ShipmentRoute.Visit.Builder getVisitsBuilder(int index)
       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;
    • getVisitsOrBuilder

      public ShipmentRoute.VisitOrBuilder getVisitsOrBuilder(int index)
       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;
      Specified by:
      getVisitsOrBuilder in interface ShipmentRouteOrBuilder
    • getVisitsOrBuilderList

      public List<? extends ShipmentRoute.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;
      Specified by:
      getVisitsOrBuilderList in interface ShipmentRouteOrBuilder
    • addVisitsBuilder

      public ShipmentRoute.Visit.Builder addVisitsBuilder()
       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;
    • addVisitsBuilder

      public ShipmentRoute.Visit.Builder addVisitsBuilder(int index)
       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;
    • getVisitsBuilderList

      public List<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;
    • getTransitionsList

      public List<ShipmentRoute.Transition> getTransitionsList()
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
      Specified by:
      getTransitionsList in interface ShipmentRouteOrBuilder
    • getTransitionsCount

      public int getTransitionsCount()
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
      Specified by:
      getTransitionsCount in interface ShipmentRouteOrBuilder
    • getTransitions

      public ShipmentRoute.Transition getTransitions(int index)
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
      Specified by:
      getTransitions in interface ShipmentRouteOrBuilder
    • setTransitions

      public ShipmentRoute.Builder setTransitions(int index, ShipmentRoute.Transition value)
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
    • setTransitions

      public ShipmentRoute.Builder setTransitions(int index, ShipmentRoute.Transition.Builder builderForValue)
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
    • addTransitions

      public ShipmentRoute.Builder addTransitions(ShipmentRoute.Transition value)
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
    • addTransitions

      public ShipmentRoute.Builder addTransitions(int index, ShipmentRoute.Transition value)
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
    • addTransitions

      public ShipmentRoute.Builder addTransitions(ShipmentRoute.Transition.Builder builderForValue)
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
    • addTransitions

      public ShipmentRoute.Builder addTransitions(int index, ShipmentRoute.Transition.Builder builderForValue)
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
    • addAllTransitions

      public ShipmentRoute.Builder addAllTransitions(Iterable<? extends ShipmentRoute.Transition> values)
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
    • clearTransitions

      public ShipmentRoute.Builder clearTransitions()
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
    • removeTransitions

      public ShipmentRoute.Builder removeTransitions(int index)
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
    • getTransitionsBuilder

      public ShipmentRoute.Transition.Builder getTransitionsBuilder(int index)
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
    • getTransitionsOrBuilder

      public ShipmentRoute.TransitionOrBuilder getTransitionsOrBuilder(int index)
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
      Specified by:
      getTransitionsOrBuilder in interface ShipmentRouteOrBuilder
    • getTransitionsOrBuilderList

      public List<? extends ShipmentRoute.TransitionOrBuilder> getTransitionsOrBuilderList()
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
      Specified by:
      getTransitionsOrBuilderList in interface ShipmentRouteOrBuilder
    • addTransitionsBuilder

      public ShipmentRoute.Transition.Builder addTransitionsBuilder()
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
    • addTransitionsBuilder

      public ShipmentRoute.Transition.Builder addTransitionsBuilder(int index)
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
    • getTransitionsBuilderList

      public List<ShipmentRoute.Transition.Builder> getTransitionsBuilderList()
       Ordered list of transitions for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.Transition transitions = 8;
    • getHasTrafficInfeasibilities

      public boolean getHasTrafficInfeasibilities()
       When
       [OptimizeToursRequest.consider_road_traffic][google.cloud.optimization.v1.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 time
       `travel_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;
      Specified by:
      getHasTrafficInfeasibilities in interface ShipmentRouteOrBuilder
      Returns:
      The hasTrafficInfeasibilities.
    • setHasTrafficInfeasibilities

      public ShipmentRoute.Builder setHasTrafficInfeasibilities(boolean value)
       When
       [OptimizeToursRequest.consider_road_traffic][google.cloud.optimization.v1.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 time
       `travel_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;
      Parameters:
      value - The hasTrafficInfeasibilities to set.
      Returns:
      This builder for chaining.
    • clearHasTrafficInfeasibilities

      public ShipmentRoute.Builder clearHasTrafficInfeasibilities()
       When
       [OptimizeToursRequest.consider_road_traffic][google.cloud.optimization.v1.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 time
       `travel_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:
      This builder for chaining.
    • hasRoutePolyline

      public boolean hasRoutePolyline()
       The encoded polyline representation of the route.
       This field is only populated if
       [OptimizeToursRequest.populate_polylines][google.cloud.optimization.v1.OptimizeToursRequest.populate_polylines]
       is set to true.
       
      .google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;
      Specified by:
      hasRoutePolyline in interface ShipmentRouteOrBuilder
      Returns:
      Whether the routePolyline field is set.
    • getRoutePolyline

      public ShipmentRoute.EncodedPolyline getRoutePolyline()
       The encoded polyline representation of the route.
       This field is only populated if
       [OptimizeToursRequest.populate_polylines][google.cloud.optimization.v1.OptimizeToursRequest.populate_polylines]
       is set to true.
       
      .google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;
      Specified by:
      getRoutePolyline in interface ShipmentRouteOrBuilder
      Returns:
      The routePolyline.
    • setRoutePolyline

      public ShipmentRoute.Builder setRoutePolyline(ShipmentRoute.EncodedPolyline value)
       The encoded polyline representation of the route.
       This field is only populated if
       [OptimizeToursRequest.populate_polylines][google.cloud.optimization.v1.OptimizeToursRequest.populate_polylines]
       is set to true.
       
      .google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;
    • setRoutePolyline

      public ShipmentRoute.Builder setRoutePolyline(ShipmentRoute.EncodedPolyline.Builder builderForValue)
       The encoded polyline representation of the route.
       This field is only populated if
       [OptimizeToursRequest.populate_polylines][google.cloud.optimization.v1.OptimizeToursRequest.populate_polylines]
       is set to true.
       
      .google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;
    • mergeRoutePolyline

      public ShipmentRoute.Builder mergeRoutePolyline(ShipmentRoute.EncodedPolyline value)
       The encoded polyline representation of the route.
       This field is only populated if
       [OptimizeToursRequest.populate_polylines][google.cloud.optimization.v1.OptimizeToursRequest.populate_polylines]
       is set to true.
       
      .google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;
    • clearRoutePolyline

      public ShipmentRoute.Builder clearRoutePolyline()
       The encoded polyline representation of the route.
       This field is only populated if
       [OptimizeToursRequest.populate_polylines][google.cloud.optimization.v1.OptimizeToursRequest.populate_polylines]
       is set to true.
       
      .google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;
    • getRoutePolylineBuilder

      public ShipmentRoute.EncodedPolyline.Builder getRoutePolylineBuilder()
       The encoded polyline representation of the route.
       This field is only populated if
       [OptimizeToursRequest.populate_polylines][google.cloud.optimization.v1.OptimizeToursRequest.populate_polylines]
       is set to true.
       
      .google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;
    • getRoutePolylineOrBuilder

      public ShipmentRoute.EncodedPolylineOrBuilder getRoutePolylineOrBuilder()
       The encoded polyline representation of the route.
       This field is only populated if
       [OptimizeToursRequest.populate_polylines][google.cloud.optimization.v1.OptimizeToursRequest.populate_polylines]
       is set to true.
       
      .google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 10;
      Specified by:
      getRoutePolylineOrBuilder in interface ShipmentRouteOrBuilder
    • getBreaksList

      public List<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;
      Specified by:
      getBreaksList in interface ShipmentRouteOrBuilder
    • getBreaksCount

      public int getBreaksCount()
       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;
      Specified by:
      getBreaksCount in interface ShipmentRouteOrBuilder
    • getBreaks

      public ShipmentRoute.Break getBreaks(int index)
       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;
      Specified by:
      getBreaks in interface ShipmentRouteOrBuilder
    • setBreaks

      public ShipmentRoute.Builder setBreaks(int index, ShipmentRoute.Break value)
       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;
    • setBreaks

      public ShipmentRoute.Builder setBreaks(int index, ShipmentRoute.Break.Builder builderForValue)
       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;
    • addBreaks

      public ShipmentRoute.Builder addBreaks(ShipmentRoute.Break value)
       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;
    • addBreaks

      public ShipmentRoute.Builder addBreaks(int index, ShipmentRoute.Break value)
       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;
    • addBreaks

      public ShipmentRoute.Builder addBreaks(ShipmentRoute.Break.Builder builderForValue)
       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;
    • addBreaks

      public ShipmentRoute.Builder addBreaks(int index, ShipmentRoute.Break.Builder builderForValue)
       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;
    • addAllBreaks

      public ShipmentRoute.Builder addAllBreaks(Iterable<? extends ShipmentRoute.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;
    • clearBreaks

      public ShipmentRoute.Builder clearBreaks()
       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;
    • removeBreaks

      public ShipmentRoute.Builder removeBreaks(int index)
       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;
    • getBreaksBuilder

      public ShipmentRoute.Break.Builder getBreaksBuilder(int index)
       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;
    • getBreaksOrBuilder

      public ShipmentRoute.BreakOrBuilder getBreaksOrBuilder(int index)
       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;
      Specified by:
      getBreaksOrBuilder in interface ShipmentRouteOrBuilder
    • getBreaksOrBuilderList

      public List<? extends ShipmentRoute.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;
      Specified by:
      getBreaksOrBuilderList in interface ShipmentRouteOrBuilder
    • addBreaksBuilder

      public ShipmentRoute.Break.Builder addBreaksBuilder()
       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;
    • addBreaksBuilder

      public ShipmentRoute.Break.Builder addBreaksBuilder(int index)
       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;
    • getBreaksBuilderList

      public List<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;
    • hasMetrics

      public boolean hasMetrics()
       Duration, distance and load metrics for this route. The fields of
       [AggregatedMetrics][google.cloud.optimization.v1.AggregatedMetrics] are
       summed over all
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       or
       [ShipmentRoute.visits][google.cloud.optimization.v1.ShipmentRoute.visits],
       depending on the context.
       
      .google.cloud.optimization.v1.AggregatedMetrics metrics = 12;
      Specified by:
      hasMetrics in interface ShipmentRouteOrBuilder
      Returns:
      Whether the metrics field is set.
    • getMetrics

      public AggregatedMetrics getMetrics()
       Duration, distance and load metrics for this route. The fields of
       [AggregatedMetrics][google.cloud.optimization.v1.AggregatedMetrics] are
       summed over all
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       or
       [ShipmentRoute.visits][google.cloud.optimization.v1.ShipmentRoute.visits],
       depending on the context.
       
      .google.cloud.optimization.v1.AggregatedMetrics metrics = 12;
      Specified by:
      getMetrics in interface ShipmentRouteOrBuilder
      Returns:
      The metrics.
    • setMetrics

      public ShipmentRoute.Builder setMetrics(AggregatedMetrics value)
       Duration, distance and load metrics for this route. The fields of
       [AggregatedMetrics][google.cloud.optimization.v1.AggregatedMetrics] are
       summed over all
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       or
       [ShipmentRoute.visits][google.cloud.optimization.v1.ShipmentRoute.visits],
       depending on the context.
       
      .google.cloud.optimization.v1.AggregatedMetrics metrics = 12;
    • setMetrics

      public ShipmentRoute.Builder setMetrics(AggregatedMetrics.Builder builderForValue)
       Duration, distance and load metrics for this route. The fields of
       [AggregatedMetrics][google.cloud.optimization.v1.AggregatedMetrics] are
       summed over all
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       or
       [ShipmentRoute.visits][google.cloud.optimization.v1.ShipmentRoute.visits],
       depending on the context.
       
      .google.cloud.optimization.v1.AggregatedMetrics metrics = 12;
    • mergeMetrics

      public ShipmentRoute.Builder mergeMetrics(AggregatedMetrics value)
       Duration, distance and load metrics for this route. The fields of
       [AggregatedMetrics][google.cloud.optimization.v1.AggregatedMetrics] are
       summed over all
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       or
       [ShipmentRoute.visits][google.cloud.optimization.v1.ShipmentRoute.visits],
       depending on the context.
       
      .google.cloud.optimization.v1.AggregatedMetrics metrics = 12;
    • clearMetrics

      public ShipmentRoute.Builder clearMetrics()
       Duration, distance and load metrics for this route. The fields of
       [AggregatedMetrics][google.cloud.optimization.v1.AggregatedMetrics] are
       summed over all
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       or
       [ShipmentRoute.visits][google.cloud.optimization.v1.ShipmentRoute.visits],
       depending on the context.
       
      .google.cloud.optimization.v1.AggregatedMetrics metrics = 12;
    • getMetricsBuilder

      public AggregatedMetrics.Builder getMetricsBuilder()
       Duration, distance and load metrics for this route. The fields of
       [AggregatedMetrics][google.cloud.optimization.v1.AggregatedMetrics] are
       summed over all
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       or
       [ShipmentRoute.visits][google.cloud.optimization.v1.ShipmentRoute.visits],
       depending on the context.
       
      .google.cloud.optimization.v1.AggregatedMetrics metrics = 12;
    • getMetricsOrBuilder

      public AggregatedMetricsOrBuilder getMetricsOrBuilder()
       Duration, distance and load metrics for this route. The fields of
       [AggregatedMetrics][google.cloud.optimization.v1.AggregatedMetrics] are
       summed over all
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       or
       [ShipmentRoute.visits][google.cloud.optimization.v1.ShipmentRoute.visits],
       depending on the context.
       
      .google.cloud.optimization.v1.AggregatedMetrics metrics = 12;
      Specified by:
      getMetricsOrBuilder in interface ShipmentRouteOrBuilder
    • getRouteCostsCount

      public int getRouteCostsCount()
      Description copied from interface: ShipmentRouteOrBuilder
       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;
      Specified by:
      getRouteCostsCount in interface ShipmentRouteOrBuilder
    • containsRouteCosts

      public boolean containsRouteCosts(String key)
       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;
      Specified by:
      containsRouteCosts in interface ShipmentRouteOrBuilder
    • getRouteCosts

      @Deprecated public Map<String,Double> getRouteCosts()
      Deprecated.
      Use getRouteCostsMap() instead.
      Specified by:
      getRouteCosts in interface ShipmentRouteOrBuilder
    • getRouteCostsMap

      public Map<String,Double> getRouteCostsMap()
       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;
      Specified by:
      getRouteCostsMap in interface ShipmentRouteOrBuilder
    • getRouteCostsOrDefault

      public double getRouteCostsOrDefault(String key, double defaultValue)
       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;
      Specified by:
      getRouteCostsOrDefault in interface ShipmentRouteOrBuilder
    • getRouteCostsOrThrow

      public double getRouteCostsOrThrow(String key)
       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;
      Specified by:
      getRouteCostsOrThrow in interface ShipmentRouteOrBuilder
    • clearRouteCosts

      public ShipmentRoute.Builder clearRouteCosts()
    • removeRouteCosts

      public ShipmentRoute.Builder removeRouteCosts(String key)
       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;
    • getMutableRouteCosts

      @Deprecated public Map<String,Double> getMutableRouteCosts()
      Deprecated.
      Use alternate mutation accessors instead.
    • putRouteCosts

      public ShipmentRoute.Builder putRouteCosts(String key, double value)
       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;
    • putAllRouteCosts

      public ShipmentRoute.Builder putAllRouteCosts(Map<String,Double> values)
       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;
    • getRouteTotalCost

      public double getRouteTotalCost()
       Total cost of the route. The sum of all costs in the cost map.
       
      double route_total_cost = 18;
      Specified by:
      getRouteTotalCost in interface ShipmentRouteOrBuilder
      Returns:
      The routeTotalCost.
    • setRouteTotalCost

      public ShipmentRoute.Builder setRouteTotalCost(double value)
       Total cost of the route. The sum of all costs in the cost map.
       
      double route_total_cost = 18;
      Parameters:
      value - The routeTotalCost to set.
      Returns:
      This builder for chaining.
    • clearRouteTotalCost

      public ShipmentRoute.Builder clearRouteTotalCost()
       Total cost of the route. The sum of all costs in the cost map.
       
      double route_total_cost = 18;
      Returns:
      This builder for chaining.
    • getEndLoadsList

      @Deprecated public List<CapacityQuantity> getEndLoadsList()
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
      Specified by:
      getEndLoadsList in interface ShipmentRouteOrBuilder
    • getEndLoadsCount

      @Deprecated public int getEndLoadsCount()
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
      Specified by:
      getEndLoadsCount in interface ShipmentRouteOrBuilder
    • getEndLoads

      @Deprecated public CapacityQuantity getEndLoads(int index)
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
      Specified by:
      getEndLoads in interface ShipmentRouteOrBuilder
    • setEndLoads

      @Deprecated public ShipmentRoute.Builder setEndLoads(int index, CapacityQuantity value)
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
    • setEndLoads

      @Deprecated public ShipmentRoute.Builder setEndLoads(int index, CapacityQuantity.Builder builderForValue)
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
    • addEndLoads

      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
    • addEndLoads

      @Deprecated public ShipmentRoute.Builder addEndLoads(int index, CapacityQuantity value)
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
    • addEndLoads

      @Deprecated public ShipmentRoute.Builder addEndLoads(CapacityQuantity.Builder builderForValue)
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
    • addEndLoads

      @Deprecated public ShipmentRoute.Builder addEndLoads(int index, CapacityQuantity.Builder builderForValue)
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
    • addAllEndLoads

      @Deprecated public ShipmentRoute.Builder addAllEndLoads(Iterable<? extends CapacityQuantity> values)
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
    • clearEndLoads

      @Deprecated public ShipmentRoute.Builder clearEndLoads()
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
    • removeEndLoads

      @Deprecated public ShipmentRoute.Builder removeEndLoads(int index)
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
    • getEndLoadsBuilder

      @Deprecated public CapacityQuantity.Builder getEndLoadsBuilder(int index)
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
    • getEndLoadsOrBuilder

      @Deprecated public CapacityQuantityOrBuilder getEndLoadsOrBuilder(int index)
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
      Specified by:
      getEndLoadsOrBuilder in interface ShipmentRouteOrBuilder
    • getEndLoadsOrBuilderList

      @Deprecated public List<? extends CapacityQuantityOrBuilder> getEndLoadsOrBuilderList()
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
      Specified by:
      getEndLoadsOrBuilderList in interface ShipmentRouteOrBuilder
    • addEndLoadsBuilder

      @Deprecated public CapacityQuantity.Builder addEndLoadsBuilder()
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
    • addEndLoadsBuilder

      @Deprecated public CapacityQuantity.Builder addEndLoadsBuilder(int index)
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
    • getEndLoadsBuilderList

      @Deprecated public List<CapacityQuantity.Builder> getEndLoadsBuilderList()
      Deprecated.
       Deprecated: Use
       [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
       instead. Vehicle loads upon arrival at its end location, for each type
       specified in
       [Vehicle.capacities][google.cloud.optimization.v1.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];
    • getTravelStepsList

      @Deprecated public List<ShipmentRoute.TravelStep> getTravelStepsList()
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
      Specified by:
      getTravelStepsList in interface ShipmentRouteOrBuilder
    • getTravelStepsCount

      @Deprecated public int getTravelStepsCount()
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
      Specified by:
      getTravelStepsCount in interface ShipmentRouteOrBuilder
    • getTravelSteps

      @Deprecated public ShipmentRoute.TravelStep getTravelSteps(int index)
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
      Specified by:
      getTravelSteps in interface ShipmentRouteOrBuilder
    • setTravelSteps

      @Deprecated public ShipmentRoute.Builder setTravelSteps(int index, ShipmentRoute.TravelStep value)
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
    • setTravelSteps

      @Deprecated public ShipmentRoute.Builder setTravelSteps(int index, ShipmentRoute.TravelStep.Builder builderForValue)
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
    • addTravelSteps

      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
    • addTravelSteps

      @Deprecated public ShipmentRoute.Builder addTravelSteps(int index, ShipmentRoute.TravelStep value)
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
    • addTravelSteps

      @Deprecated public ShipmentRoute.Builder addTravelSteps(ShipmentRoute.TravelStep.Builder builderForValue)
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
    • addTravelSteps

      @Deprecated public ShipmentRoute.Builder addTravelSteps(int index, ShipmentRoute.TravelStep.Builder builderForValue)
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
    • addAllTravelSteps

      @Deprecated public ShipmentRoute.Builder addAllTravelSteps(Iterable<? extends ShipmentRoute.TravelStep> values)
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
    • clearTravelSteps

      @Deprecated public ShipmentRoute.Builder clearTravelSteps()
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
    • removeTravelSteps

      @Deprecated public ShipmentRoute.Builder removeTravelSteps(int index)
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
    • getTravelStepsBuilder

      @Deprecated public ShipmentRoute.TravelStep.Builder getTravelStepsBuilder(int index)
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
    • getTravelStepsOrBuilder

      @Deprecated public ShipmentRoute.TravelStepOrBuilder getTravelStepsOrBuilder(int index)
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
      Specified by:
      getTravelStepsOrBuilder in interface ShipmentRouteOrBuilder
    • getTravelStepsOrBuilderList

      @Deprecated public List<? extends ShipmentRoute.TravelStepOrBuilder> getTravelStepsOrBuilderList()
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
      Specified by:
      getTravelStepsOrBuilderList in interface ShipmentRouteOrBuilder
    • addTravelStepsBuilder

      @Deprecated public ShipmentRoute.TravelStep.Builder addTravelStepsBuilder()
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
    • addTravelStepsBuilder

      @Deprecated public ShipmentRoute.TravelStep.Builder addTravelStepsBuilder(int index)
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
    • getTravelStepsBuilderList

      @Deprecated public List<ShipmentRoute.TravelStep.Builder> getTravelStepsBuilderList()
      Deprecated.
       Deprecated: Use
       [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
       instead. Ordered list of travel steps for the route.
       
      repeated .google.cloud.optimization.v1.ShipmentRoute.TravelStep travel_steps = 14 [deprecated = true];
    • hasVehicleDetour

      @Deprecated public boolean hasVehicleDetour()
      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][google.cloud.optimization.v1.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];
      Specified by:
      hasVehicleDetour in interface ShipmentRouteOrBuilder
      Returns:
      Whether the vehicleDetour field is set.
    • getVehicleDetour

      @Deprecated public com.google.protobuf.Duration getVehicleDetour()
      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][google.cloud.optimization.v1.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];
      Specified by:
      getVehicleDetour in interface ShipmentRouteOrBuilder
      Returns:
      The vehicleDetour.
    • setVehicleDetour

      @Deprecated public ShipmentRoute.Builder setVehicleDetour(com.google.protobuf.Duration value)
      Deprecated.
       Deprecated: No longer used.
       This field will only be populated at the
       [ShipmentRoute.Visit][google.cloud.optimization.v1.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];
    • setVehicleDetour

      @Deprecated public ShipmentRoute.Builder setVehicleDetour(com.google.protobuf.Duration.Builder builderForValue)
      Deprecated.
       Deprecated: No longer used.
       This field will only be populated at the
       [ShipmentRoute.Visit][google.cloud.optimization.v1.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];
    • mergeVehicleDetour

      @Deprecated public ShipmentRoute.Builder mergeVehicleDetour(com.google.protobuf.Duration value)
      Deprecated.
       Deprecated: No longer used.
       This field will only be populated at the
       [ShipmentRoute.Visit][google.cloud.optimization.v1.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];
    • clearVehicleDetour

      @Deprecated public ShipmentRoute.Builder clearVehicleDetour()
      Deprecated.
       Deprecated: No longer used.
       This field will only be populated at the
       [ShipmentRoute.Visit][google.cloud.optimization.v1.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];
    • getVehicleDetourBuilder

      @Deprecated public com.google.protobuf.Duration.Builder getVehicleDetourBuilder()
      Deprecated.
       Deprecated: No longer used.
       This field will only be populated at the
       [ShipmentRoute.Visit][google.cloud.optimization.v1.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];
    • getVehicleDetourOrBuilder

      @Deprecated public com.google.protobuf.DurationOrBuilder getVehicleDetourOrBuilder()
      Deprecated.
       Deprecated: No longer used.
       This field will only be populated at the
       [ShipmentRoute.Visit][google.cloud.optimization.v1.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];
      Specified by:
      getVehicleDetourOrBuilder in interface ShipmentRouteOrBuilder
    • hasDelayBeforeVehicleEnd

      @Deprecated public boolean hasDelayBeforeVehicleEnd()
      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.TransitionAttributes.delay].
       
      .google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];
      Specified by:
      hasDelayBeforeVehicleEnd in interface ShipmentRouteOrBuilder
      Returns:
      Whether the delayBeforeVehicleEnd field is set.
    • getDelayBeforeVehicleEnd

      @Deprecated public ShipmentRoute.Delay getDelayBeforeVehicleEnd()
      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.TransitionAttributes.delay].
       
      .google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];
      Specified by:
      getDelayBeforeVehicleEnd in interface ShipmentRouteOrBuilder
      Returns:
      The delayBeforeVehicleEnd.
    • setDelayBeforeVehicleEnd

      @Deprecated public ShipmentRoute.Builder setDelayBeforeVehicleEnd(ShipmentRoute.Delay value)
      Deprecated.
       Deprecated: Delay occurring before the vehicle end. See
       [TransitionAttributes.delay][google.cloud.optimization.v1.TransitionAttributes.delay].
       
      .google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];
    • setDelayBeforeVehicleEnd

      @Deprecated public ShipmentRoute.Builder setDelayBeforeVehicleEnd(ShipmentRoute.Delay.Builder builderForValue)
      Deprecated.
       Deprecated: Delay occurring before the vehicle end. See
       [TransitionAttributes.delay][google.cloud.optimization.v1.TransitionAttributes.delay].
       
      .google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];
    • mergeDelayBeforeVehicleEnd

      @Deprecated public ShipmentRoute.Builder mergeDelayBeforeVehicleEnd(ShipmentRoute.Delay value)
      Deprecated.
       Deprecated: Delay occurring before the vehicle end. See
       [TransitionAttributes.delay][google.cloud.optimization.v1.TransitionAttributes.delay].
       
      .google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];
    • clearDelayBeforeVehicleEnd

      @Deprecated public ShipmentRoute.Builder clearDelayBeforeVehicleEnd()
      Deprecated.
       Deprecated: Delay occurring before the vehicle end. See
       [TransitionAttributes.delay][google.cloud.optimization.v1.TransitionAttributes.delay].
       
      .google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];
    • getDelayBeforeVehicleEndBuilder

      @Deprecated public ShipmentRoute.Delay.Builder getDelayBeforeVehicleEndBuilder()
      Deprecated.
       Deprecated: Delay occurring before the vehicle end. See
       [TransitionAttributes.delay][google.cloud.optimization.v1.TransitionAttributes.delay].
       
      .google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];
    • getDelayBeforeVehicleEndOrBuilder

      @Deprecated public ShipmentRoute.DelayOrBuilder getDelayBeforeVehicleEndOrBuilder()
      Deprecated.
       Deprecated: Delay occurring before the vehicle end. See
       [TransitionAttributes.delay][google.cloud.optimization.v1.TransitionAttributes.delay].
       
      .google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_vehicle_end = 16 [deprecated = true];
      Specified by:
      getDelayBeforeVehicleEndOrBuilder in interface ShipmentRouteOrBuilder