Package com.google.cloud.optimization.v1

Interface ShipmentRoute.TransitionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ShipmentRoute.Transition, ShipmentRoute.Transition.Builder
Enclosing class:
ShipmentRoute
public static interface ShipmentRoute.TransitionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsVehicleLoads(String key)
    Vehicle loads during this transition, for each type that either appears in this vehicle's [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits], or that have non-zero [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] on some shipment performed on this route.
    com.google.protobuf.Duration
    getBreakDuration()
    Sum of the duration of the breaks occurring during this transition, if any.
    com.google.protobuf.DurationOrBuilder
    getBreakDurationOrBuilder()
    Sum of the duration of the breaks occurring during this transition, if any.
    com.google.protobuf.Duration
    getDelayDuration()
    Sum of the delay durations applied to this transition.
    com.google.protobuf.DurationOrBuilder
    getDelayDurationOrBuilder()
    Sum of the delay durations applied to this transition.
    CapacityQuantity
    getLoads(int index)
    Deprecated.
    int
    getLoadsCount()
    Deprecated.
    List<CapacityQuantity>
    getLoadsList()
    Deprecated.
    CapacityQuantityOrBuilder
    getLoadsOrBuilder(int index)
    Deprecated.
    List<? extends CapacityQuantityOrBuilder>
    getLoadsOrBuilderList()
    Deprecated.
    ShipmentRoute.EncodedPolyline
    getRoutePolyline()
    The encoded polyline representation of the route followed during the transition.
    ShipmentRoute.EncodedPolylineOrBuilder
    getRoutePolylineOrBuilder()
    The encoded polyline representation of the route followed during the transition.
    com.google.protobuf.Timestamp
    getStartTime()
    Start time of this transition.
    com.google.protobuf.TimestampOrBuilder
    getStartTimeOrBuilder()
    Start time of this transition.
    com.google.protobuf.Duration
    getTotalDuration()
    Total duration of the transition, provided for convenience.
    com.google.protobuf.DurationOrBuilder
    getTotalDurationOrBuilder()
    Total duration of the transition, provided for convenience.
    boolean
    getTrafficInfoUnavailable()
    When traffic is requested via [OptimizeToursRequest.consider_road_traffic] [google.cloud.optimization.v1.OptimizeToursRequest.consider_road_traffic], and the traffic info couldn't be retrieved for a `Transition`, this boolean is set to true.
    double
    getTravelDistanceMeters()
    Distance traveled during the transition.
    com.google.protobuf.Duration
    getTravelDuration()
    Travel duration during this transition.
    com.google.protobuf.DurationOrBuilder
    getTravelDurationOrBuilder()
    Travel duration during this transition.
    Map<String,ShipmentRoute.VehicleLoad>
    getVehicleLoads()
    Deprecated.
    int
    getVehicleLoadsCount()
    Vehicle loads during this transition, for each type that either appears in this vehicle's [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits], or that have non-zero [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] on some shipment performed on this route.
    Map<String,ShipmentRoute.VehicleLoad>
    getVehicleLoadsMap()
    Vehicle loads during this transition, for each type that either appears in this vehicle's [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits], or that have non-zero [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] on some shipment performed on this route.
    ShipmentRoute.VehicleLoad
    getVehicleLoadsOrDefault(String key, ShipmentRoute.VehicleLoad defaultValue)
    Vehicle loads during this transition, for each type that either appears in this vehicle's [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits], or that have non-zero [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] on some shipment performed on this route.
    ShipmentRoute.VehicleLoad
    getVehicleLoadsOrThrow(String key)
    Vehicle loads during this transition, for each type that either appears in this vehicle's [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits], or that have non-zero [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] on some shipment performed on this route.
    com.google.protobuf.Duration
    getWaitDuration()
    Time spent waiting during this transition.
    com.google.protobuf.DurationOrBuilder
    getWaitDurationOrBuilder()
    Time spent waiting during this transition.
    boolean
    hasBreakDuration()
    Sum of the duration of the breaks occurring during this transition, if any.
    boolean
    hasDelayDuration()
    Sum of the delay durations applied to this transition.
    boolean
    hasRoutePolyline()
    The encoded polyline representation of the route followed during the transition.
    boolean
    hasStartTime()
    Start time of this transition.
    boolean
    hasTotalDuration()
    Total duration of the transition, provided for convenience.
    boolean
    hasTravelDuration()
    Travel duration during this transition.
    boolean
    hasWaitDuration()
    Time spent waiting during this transition.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasTravelDuration

      boolean hasTravelDuration()
       Travel duration during this transition.
      .google.protobuf.Duration travel_duration = 1;
      Returns:
      Whether the travelDuration field is set.

    • getTravelDuration

      com.google.protobuf.Duration getTravelDuration()
       Travel duration during this transition.
      .google.protobuf.Duration travel_duration = 1;
      Returns:
      The travelDuration.

    • getTravelDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getTravelDurationOrBuilder()
       Travel duration during this transition.
      .google.protobuf.Duration travel_duration = 1;

    • getTravelDistanceMeters

      double getTravelDistanceMeters()
       Distance traveled during the transition.
      double travel_distance_meters = 2;
      Returns:
      The travelDistanceMeters.

    • getTrafficInfoUnavailable

      boolean getTrafficInfoUnavailable()
       When traffic is requested via
 [OptimizeToursRequest.consider_road_traffic]
 [google.cloud.optimization.v1.OptimizeToursRequest.consider_road_traffic],
 and the traffic info couldn't be retrieved for a `Transition`, this
 boolean is set to true. This may be temporary (rare hiccup in the
 realtime traffic servers) or permanent (no data for this location).
      bool traffic_info_unavailable = 3;
      Returns:
      The trafficInfoUnavailable.

    • hasDelayDuration

      boolean hasDelayDuration()
       Sum of the delay durations applied to this transition. If any, the delay
 starts exactly `delay_duration` seconds before the next event (visit or
 vehicle end). See
 [TransitionAttributes.delay][google.cloud.optimization.v1.TransitionAttributes.delay].
      .google.protobuf.Duration delay_duration = 4;
      Returns:
      Whether the delayDuration field is set.

    • getDelayDuration

      com.google.protobuf.Duration getDelayDuration()
       Sum of the delay durations applied to this transition. If any, the delay
 starts exactly `delay_duration` seconds before the next event (visit or
 vehicle end). See
 [TransitionAttributes.delay][google.cloud.optimization.v1.TransitionAttributes.delay].
      .google.protobuf.Duration delay_duration = 4;
      Returns:
      The delayDuration.

    • getDelayDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getDelayDurationOrBuilder()
       Sum of the delay durations applied to this transition. If any, the delay
 starts exactly `delay_duration` seconds before the next event (visit or
 vehicle end). See
 [TransitionAttributes.delay][google.cloud.optimization.v1.TransitionAttributes.delay].
      .google.protobuf.Duration delay_duration = 4;

    • hasBreakDuration

      boolean hasBreakDuration()
       Sum of the duration of the breaks occurring during this transition, if
 any. Details about each break's start time and duration are stored in
 [ShipmentRoute.breaks][google.cloud.optimization.v1.ShipmentRoute.breaks].
      .google.protobuf.Duration break_duration = 5;
      Returns:
      Whether the breakDuration field is set.

    • getBreakDuration

      com.google.protobuf.Duration getBreakDuration()
       Sum of the duration of the breaks occurring during this transition, if
 any. Details about each break's start time and duration are stored in
 [ShipmentRoute.breaks][google.cloud.optimization.v1.ShipmentRoute.breaks].
      .google.protobuf.Duration break_duration = 5;
      Returns:
      The breakDuration.

    • getBreakDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getBreakDurationOrBuilder()
       Sum of the duration of the breaks occurring during this transition, if
 any. Details about each break's start time and duration are stored in
 [ShipmentRoute.breaks][google.cloud.optimization.v1.ShipmentRoute.breaks].
      .google.protobuf.Duration break_duration = 5;

    • hasWaitDuration

      boolean hasWaitDuration()
       Time spent waiting during this transition. Wait duration corresponds to
 idle time and does not include break time. Also note that this wait time
 may be split into several non-contiguous intervals.
      .google.protobuf.Duration wait_duration = 6;
      Returns:
      Whether the waitDuration field is set.

    • getWaitDuration

      com.google.protobuf.Duration getWaitDuration()
       Time spent waiting during this transition. Wait duration corresponds to
 idle time and does not include break time. Also note that this wait time
 may be split into several non-contiguous intervals.
      .google.protobuf.Duration wait_duration = 6;
      Returns:
      The waitDuration.

    • getWaitDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getWaitDurationOrBuilder()
       Time spent waiting during this transition. Wait duration corresponds to
 idle time and does not include break time. Also note that this wait time
 may be split into several non-contiguous intervals.
      .google.protobuf.Duration wait_duration = 6;

    • hasTotalDuration

      boolean hasTotalDuration()
       Total duration of the transition, provided for convenience. It is equal
 to:

 * next visit `start_time` (or `vehicle_end_time` if this is the last
 transition) - this transition's `start_time`;
 * if `ShipmentRoute.has_traffic_infeasibilities` is false, the following
 additionally holds: `total_duration = travel_duration + delay_duration
 + break_duration + wait_duration`.
      .google.protobuf.Duration total_duration = 7;
      Returns:
      Whether the totalDuration field is set.

    • getTotalDuration

      com.google.protobuf.Duration getTotalDuration()
       Total duration of the transition, provided for convenience. It is equal
 to:

 * next visit `start_time` (or `vehicle_end_time` if this is the last
 transition) - this transition's `start_time`;
 * if `ShipmentRoute.has_traffic_infeasibilities` is false, the following
 additionally holds: `total_duration = travel_duration + delay_duration
 + break_duration + wait_duration`.
      .google.protobuf.Duration total_duration = 7;
      Returns:
      The totalDuration.

    • getTotalDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getTotalDurationOrBuilder()
       Total duration of the transition, provided for convenience. It is equal
 to:

 * next visit `start_time` (or `vehicle_end_time` if this is the last
 transition) - this transition's `start_time`;
 * if `ShipmentRoute.has_traffic_infeasibilities` is false, the following
 additionally holds: `total_duration = travel_duration + delay_duration
 + break_duration + wait_duration`.
      .google.protobuf.Duration total_duration = 7;

    • hasStartTime

      boolean hasStartTime()
       Start time of this transition.
      .google.protobuf.Timestamp start_time = 8;
      Returns:
      Whether the startTime field is set.

    • getStartTime

      com.google.protobuf.Timestamp getStartTime()
       Start time of this transition.
      .google.protobuf.Timestamp start_time = 8;
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       Start time of this transition.
      .google.protobuf.Timestamp start_time = 8;

    • hasRoutePolyline

      boolean hasRoutePolyline()
       The encoded polyline representation of the route followed during the
 transition.
 This field is only populated if [populate_transition_polylines]
 [google.cloud.optimization.v1.OptimizeToursRequest.populate_transition_polylines]
 is set to true.
      .google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 9;
      Returns:
      Whether the routePolyline field is set.

    • getRoutePolyline

      ShipmentRoute.EncodedPolyline getRoutePolyline()
       The encoded polyline representation of the route followed during the
 transition.
 This field is only populated if [populate_transition_polylines]
 [google.cloud.optimization.v1.OptimizeToursRequest.populate_transition_polylines]
 is set to true.
      .google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 9;
      Returns:
      The routePolyline.

    • getRoutePolylineOrBuilder

      ShipmentRoute.EncodedPolylineOrBuilder getRoutePolylineOrBuilder()
       The encoded polyline representation of the route followed during the
 transition.
 This field is only populated if [populate_transition_polylines]
 [google.cloud.optimization.v1.OptimizeToursRequest.populate_transition_polylines]
 is set to true.
      .google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline route_polyline = 9;

    • getVehicleLoadsCount

      int getVehicleLoadsCount()
       Vehicle loads during this transition, for each type that either appears
 in this vehicle's
 [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits],
 or that have non-zero
 [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
 on some shipment performed on this route.

 The loads during the first transition are the starting loads of the
 vehicle route. Then, after each visit, the visit's `load_demands` are
 either added or subtracted to get the next transition's loads, depending
 on whether the visit was a pickup or a delivery.
      map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> vehicle_loads = 11;

    • containsVehicleLoads

      boolean containsVehicleLoads(String key)
       Vehicle loads during this transition, for each type that either appears
 in this vehicle's
 [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits],
 or that have non-zero
 [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
 on some shipment performed on this route.

 The loads during the first transition are the starting loads of the
 vehicle route. Then, after each visit, the visit's `load_demands` are
 either added or subtracted to get the next transition's loads, depending
 on whether the visit was a pickup or a delivery.
      map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> vehicle_loads = 11;

    • getVehicleLoads

      @Deprecated Map<String,ShipmentRoute.VehicleLoad> getVehicleLoads()
      Deprecated.
      Use getVehicleLoadsMap() instead.

    • getVehicleLoadsMap

      Map<String,ShipmentRoute.VehicleLoad> getVehicleLoadsMap()
       Vehicle loads during this transition, for each type that either appears
 in this vehicle's
 [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits],
 or that have non-zero
 [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
 on some shipment performed on this route.

 The loads during the first transition are the starting loads of the
 vehicle route. Then, after each visit, the visit's `load_demands` are
 either added or subtracted to get the next transition's loads, depending
 on whether the visit was a pickup or a delivery.
      map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> vehicle_loads = 11;

    • getVehicleLoadsOrDefault

      ShipmentRoute.VehicleLoad getVehicleLoadsOrDefault(String key, ShipmentRoute.VehicleLoad defaultValue)
       Vehicle loads during this transition, for each type that either appears
 in this vehicle's
 [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits],
 or that have non-zero
 [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
 on some shipment performed on this route.

 The loads during the first transition are the starting loads of the
 vehicle route. Then, after each visit, the visit's `load_demands` are
 either added or subtracted to get the next transition's loads, depending
 on whether the visit was a pickup or a delivery.
      map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> vehicle_loads = 11;

    • getVehicleLoadsOrThrow

      ShipmentRoute.VehicleLoad getVehicleLoadsOrThrow(String key)
       Vehicle loads during this transition, for each type that either appears
 in this vehicle's
 [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits],
 or that have non-zero
 [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
 on some shipment performed on this route.

 The loads during the first transition are the starting loads of the
 vehicle route. Then, after each visit, the visit's `load_demands` are
 either added or subtracted to get the next transition's loads, depending
 on whether the visit was a pickup or a delivery.
      map<string, .google.cloud.optimization.v1.ShipmentRoute.VehicleLoad> vehicle_loads = 11;

    • getLoadsList

      @Deprecated List<CapacityQuantity> getLoadsList()
      Deprecated.
       Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead.
      repeated .google.cloud.optimization.v1.CapacityQuantity loads = 10 [deprecated = true];

    • getLoads

      @Deprecated CapacityQuantity getLoads(int index)
      Deprecated.
       Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead.
      repeated .google.cloud.optimization.v1.CapacityQuantity loads = 10 [deprecated = true];

    • getLoadsCount

      @Deprecated int getLoadsCount()
      Deprecated.
       Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead.
      repeated .google.cloud.optimization.v1.CapacityQuantity loads = 10 [deprecated = true];

    • getLoadsOrBuilderList

      @Deprecated List<? extends CapacityQuantityOrBuilder> getLoadsOrBuilderList()
      Deprecated.
       Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead.
      repeated .google.cloud.optimization.v1.CapacityQuantity loads = 10 [deprecated = true];

    • getLoadsOrBuilder

      @Deprecated CapacityQuantityOrBuilder getLoadsOrBuilder(int index)
      Deprecated.
       Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead.
      repeated .google.cloud.optimization.v1.CapacityQuantity loads = 10 [deprecated = true];