Package com.google.cloud.optimization.v1

Interface VehicleOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Vehicle, Vehicle.Builder
    public interface VehicleOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getTravelModeValue

        int getTravelModeValue()
         The travel mode which affects the roads usable by the vehicle and its
 speed. See also `travel_duration_multiple`.
        .google.cloud.optimization.v1.Vehicle.TravelMode travel_mode = 1;
        Returns:
        The enum numeric value on the wire for travelMode.

      • getTravelMode

        Vehicle.TravelMode getTravelMode()
         The travel mode which affects the roads usable by the vehicle and its
 speed. See also `travel_duration_multiple`.
        .google.cloud.optimization.v1.Vehicle.TravelMode travel_mode = 1;
        Returns:
        The travelMode.

      • hasStartLocation

        boolean hasStartLocation()
         Geographic location where the vehicle starts before picking up any
 shipments. If not specified, the vehicle starts at its first pickup.
 If the shipment model has duration and distance matrices, `start_location`
 must not be specified.
        .google.type.LatLng start_location = 3;
        Returns:
        Whether the startLocation field is set.

      • getStartLocation

        com.google.type.LatLng getStartLocation()
         Geographic location where the vehicle starts before picking up any
 shipments. If not specified, the vehicle starts at its first pickup.
 If the shipment model has duration and distance matrices, `start_location`
 must not be specified.
        .google.type.LatLng start_location = 3;
        Returns:
        The startLocation.

      • getStartLocationOrBuilder

        com.google.type.LatLngOrBuilder getStartLocationOrBuilder()
         Geographic location where the vehicle starts before picking up any
 shipments. If not specified, the vehicle starts at its first pickup.
 If the shipment model has duration and distance matrices, `start_location`
 must not be specified.
        .google.type.LatLng start_location = 3;

      • hasStartWaypoint

        boolean hasStartWaypoint()
         Waypoint representing a geographic location where the vehicle starts before
 picking up any shipments. If neither `start_waypoint` nor `start_location`
 is specified, the vehicle starts at its first pickup.
 If the shipment model has duration and distance matrices, `start_waypoint`
 must not be specified.
        .google.cloud.optimization.v1.Waypoint start_waypoint = 4;
        Returns:
        Whether the startWaypoint field is set.

      • getStartWaypoint

        Waypoint getStartWaypoint()
         Waypoint representing a geographic location where the vehicle starts before
 picking up any shipments. If neither `start_waypoint` nor `start_location`
 is specified, the vehicle starts at its first pickup.
 If the shipment model has duration and distance matrices, `start_waypoint`
 must not be specified.
        .google.cloud.optimization.v1.Waypoint start_waypoint = 4;
        Returns:
        The startWaypoint.

      • getStartWaypointOrBuilder

        WaypointOrBuilder getStartWaypointOrBuilder()
         Waypoint representing a geographic location where the vehicle starts before
 picking up any shipments. If neither `start_waypoint` nor `start_location`
 is specified, the vehicle starts at its first pickup.
 If the shipment model has duration and distance matrices, `start_waypoint`
 must not be specified.
        .google.cloud.optimization.v1.Waypoint start_waypoint = 4;

      • hasEndLocation

        boolean hasEndLocation()
         Geographic location where the vehicle ends after it has completed its last
 `VisitRequest`. If not specified the vehicle's `ShipmentRoute` ends
 immediately when it completes its last `VisitRequest`.
 If the shipment model has duration and distance matrices, `end_location`
 must not be specified.
        .google.type.LatLng end_location = 5;
        Returns:
        Whether the endLocation field is set.

      • getEndLocation

        com.google.type.LatLng getEndLocation()
         Geographic location where the vehicle ends after it has completed its last
 `VisitRequest`. If not specified the vehicle's `ShipmentRoute` ends
 immediately when it completes its last `VisitRequest`.
 If the shipment model has duration and distance matrices, `end_location`
 must not be specified.
        .google.type.LatLng end_location = 5;
        Returns:
        The endLocation.

      • getEndLocationOrBuilder

        com.google.type.LatLngOrBuilder getEndLocationOrBuilder()
         Geographic location where the vehicle ends after it has completed its last
 `VisitRequest`. If not specified the vehicle's `ShipmentRoute` ends
 immediately when it completes its last `VisitRequest`.
 If the shipment model has duration and distance matrices, `end_location`
 must not be specified.
        .google.type.LatLng end_location = 5;

      • hasEndWaypoint

        boolean hasEndWaypoint()
         Waypoint representing a geographic location where the vehicle ends after
 it has completed its last `VisitRequest`. If neither `end_waypoint` nor
 `end_location` is specified, the vehicle's `ShipmentRoute` ends immediately
 when it completes its last `VisitRequest`.
 If the shipment model has duration and distance matrices, `end_waypoint`
 must not be specified.
        .google.cloud.optimization.v1.Waypoint end_waypoint = 6;
        Returns:
        Whether the endWaypoint field is set.

      • getEndWaypoint

        Waypoint getEndWaypoint()
         Waypoint representing a geographic location where the vehicle ends after
 it has completed its last `VisitRequest`. If neither `end_waypoint` nor
 `end_location` is specified, the vehicle's `ShipmentRoute` ends immediately
 when it completes its last `VisitRequest`.
 If the shipment model has duration and distance matrices, `end_waypoint`
 must not be specified.
        .google.cloud.optimization.v1.Waypoint end_waypoint = 6;
        Returns:
        The endWaypoint.

      • getEndWaypointOrBuilder

        WaypointOrBuilder getEndWaypointOrBuilder()
         Waypoint representing a geographic location where the vehicle ends after
 it has completed its last `VisitRequest`. If neither `end_waypoint` nor
 `end_location` is specified, the vehicle's `ShipmentRoute` ends immediately
 when it completes its last `VisitRequest`.
 If the shipment model has duration and distance matrices, `end_waypoint`
 must not be specified.
        .google.cloud.optimization.v1.Waypoint end_waypoint = 6;

      • getStartTagsList

        List<String> getStartTagsList()
         Specifies tags attached to the start of the vehicle's route.

 Empty or duplicate strings are not allowed.
        repeated string start_tags = 7;
        Returns:
        A list containing the startTags.

      • getStartTagsCount

        int getStartTagsCount()
         Specifies tags attached to the start of the vehicle's route.

 Empty or duplicate strings are not allowed.
        repeated string start_tags = 7;
        Returns:
        The count of startTags.

      • getStartTags

        String getStartTags​(int index)
         Specifies tags attached to the start of the vehicle's route.

 Empty or duplicate strings are not allowed.
        repeated string start_tags = 7;
        Parameters:
        index - The index of the element to return.
        Returns:
        The startTags at the given index.

      • getStartTagsBytes

        com.google.protobuf.ByteString getStartTagsBytes​(int index)
         Specifies tags attached to the start of the vehicle's route.

 Empty or duplicate strings are not allowed.
        repeated string start_tags = 7;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the startTags at the given index.

      • getEndTagsList

        List<String> getEndTagsList()
         Specifies tags attached to the end of the vehicle's route.

 Empty or duplicate strings are not allowed.
        repeated string end_tags = 8;
        Returns:
        A list containing the endTags.

      • getEndTagsCount

        int getEndTagsCount()
         Specifies tags attached to the end of the vehicle's route.

 Empty or duplicate strings are not allowed.
        repeated string end_tags = 8;
        Returns:
        The count of endTags.

      • getEndTags

        String getEndTags​(int index)
         Specifies tags attached to the end of the vehicle's route.

 Empty or duplicate strings are not allowed.
        repeated string end_tags = 8;
        Parameters:
        index - The index of the element to return.
        Returns:
        The endTags at the given index.

      • getEndTagsBytes

        com.google.protobuf.ByteString getEndTagsBytes​(int index)
         Specifies tags attached to the end of the vehicle's route.

 Empty or duplicate strings are not allowed.
        repeated string end_tags = 8;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the endTags at the given index.

      • getStartTimeWindowsList

        List<TimeWindow> getStartTimeWindowsList()
         Time windows during which the vehicle may depart its start location.
 They must be within the global time limits (see
 [ShipmentModel.global_*][google.cloud.optimization.v1.ShipmentModel.global_start_time]
 fields). If unspecified, there is no limitation besides those global time
 limits.

 Time windows belonging to the same repeated field must be disjoint, i.e. no
 time window can overlap with or be adjacent to another, and they must be in
 chronological order.

 `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if
 there is a single time window.
        repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;

      • getStartTimeWindows

        TimeWindow getStartTimeWindows​(int index)
         Time windows during which the vehicle may depart its start location.
 They must be within the global time limits (see
 [ShipmentModel.global_*][google.cloud.optimization.v1.ShipmentModel.global_start_time]
 fields). If unspecified, there is no limitation besides those global time
 limits.

 Time windows belonging to the same repeated field must be disjoint, i.e. no
 time window can overlap with or be adjacent to another, and they must be in
 chronological order.

 `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if
 there is a single time window.
        repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;

      • getStartTimeWindowsCount

        int getStartTimeWindowsCount()
         Time windows during which the vehicle may depart its start location.
 They must be within the global time limits (see
 [ShipmentModel.global_*][google.cloud.optimization.v1.ShipmentModel.global_start_time]
 fields). If unspecified, there is no limitation besides those global time
 limits.

 Time windows belonging to the same repeated field must be disjoint, i.e. no
 time window can overlap with or be adjacent to another, and they must be in
 chronological order.

 `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if
 there is a single time window.
        repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;

      • getStartTimeWindowsOrBuilderList

        List<? extends TimeWindowOrBuilder> getStartTimeWindowsOrBuilderList()
         Time windows during which the vehicle may depart its start location.
 They must be within the global time limits (see
 [ShipmentModel.global_*][google.cloud.optimization.v1.ShipmentModel.global_start_time]
 fields). If unspecified, there is no limitation besides those global time
 limits.

 Time windows belonging to the same repeated field must be disjoint, i.e. no
 time window can overlap with or be adjacent to another, and they must be in
 chronological order.

 `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if
 there is a single time window.
        repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;

      • getStartTimeWindowsOrBuilder

        TimeWindowOrBuilder getStartTimeWindowsOrBuilder​(int index)
         Time windows during which the vehicle may depart its start location.
 They must be within the global time limits (see
 [ShipmentModel.global_*][google.cloud.optimization.v1.ShipmentModel.global_start_time]
 fields). If unspecified, there is no limitation besides those global time
 limits.

 Time windows belonging to the same repeated field must be disjoint, i.e. no
 time window can overlap with or be adjacent to another, and they must be in
 chronological order.

 `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if
 there is a single time window.
        repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;

      • getEndTimeWindowsList

        List<TimeWindow> getEndTimeWindowsList()
         Time windows during which the vehicle may arrive at its end location.
 They must be within the global time limits (see
 [ShipmentModel.global_*][google.cloud.optimization.v1.ShipmentModel.global_start_time]
 fields). If unspecified, there is no limitation besides those global time
 limits.

 Time windows belonging to the same repeated field must be disjoint, i.e. no
 time window can overlap with or be adjacent to another, and they must be in
 chronological order.

 `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if
 there is a single time window.
        repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;

      • getEndTimeWindows

        TimeWindow getEndTimeWindows​(int index)
         Time windows during which the vehicle may arrive at its end location.
 They must be within the global time limits (see
 [ShipmentModel.global_*][google.cloud.optimization.v1.ShipmentModel.global_start_time]
 fields). If unspecified, there is no limitation besides those global time
 limits.

 Time windows belonging to the same repeated field must be disjoint, i.e. no
 time window can overlap with or be adjacent to another, and they must be in
 chronological order.

 `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if
 there is a single time window.
        repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;

      • getEndTimeWindowsCount

        int getEndTimeWindowsCount()
         Time windows during which the vehicle may arrive at its end location.
 They must be within the global time limits (see
 [ShipmentModel.global_*][google.cloud.optimization.v1.ShipmentModel.global_start_time]
 fields). If unspecified, there is no limitation besides those global time
 limits.

 Time windows belonging to the same repeated field must be disjoint, i.e. no
 time window can overlap with or be adjacent to another, and they must be in
 chronological order.

 `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if
 there is a single time window.
        repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;

      • getEndTimeWindowsOrBuilderList

        List<? extends TimeWindowOrBuilder> getEndTimeWindowsOrBuilderList()
         Time windows during which the vehicle may arrive at its end location.
 They must be within the global time limits (see
 [ShipmentModel.global_*][google.cloud.optimization.v1.ShipmentModel.global_start_time]
 fields). If unspecified, there is no limitation besides those global time
 limits.

 Time windows belonging to the same repeated field must be disjoint, i.e. no
 time window can overlap with or be adjacent to another, and they must be in
 chronological order.

 `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if
 there is a single time window.
        repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;

      • getEndTimeWindowsOrBuilder

        TimeWindowOrBuilder getEndTimeWindowsOrBuilder​(int index)
         Time windows during which the vehicle may arrive at its end location.
 They must be within the global time limits (see
 [ShipmentModel.global_*][google.cloud.optimization.v1.ShipmentModel.global_start_time]
 fields). If unspecified, there is no limitation besides those global time
 limits.

 Time windows belonging to the same repeated field must be disjoint, i.e. no
 time window can overlap with or be adjacent to another, and they must be in
 chronological order.

 `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if
 there is a single time window.
        repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;

      • hasTravelDurationMultiple

        boolean hasTravelDurationMultiple()
         Specifies a multiplicative factor that can be used to increase or decrease
 travel times of this vehicle. For example, setting this to 2.0 means
 that this vehicle is slower and has travel times that are twice what they
 are for standard vehicles. This multiple does not affect visit durations.
 It does affect cost if `cost_per_hour` or `cost_per_traveled_hour` are
 specified. This must be in the range [0.001, 1000.0]. If unset, the vehicle
 is standard, and this multiple is considered 1.0.

 WARNING: Travel times will be rounded to the nearest second after this
 multiple is applied but before performing any numerical operations, thus,
 a small multiple may result in a loss of precision.

 See also `extra_visit_duration_for_visit_type` below.
        optional double travel_duration_multiple = 11;
        Returns:
        Whether the travelDurationMultiple field is set.

      • getTravelDurationMultiple

        double getTravelDurationMultiple()
         Specifies a multiplicative factor that can be used to increase or decrease
 travel times of this vehicle. For example, setting this to 2.0 means
 that this vehicle is slower and has travel times that are twice what they
 are for standard vehicles. This multiple does not affect visit durations.
 It does affect cost if `cost_per_hour` or `cost_per_traveled_hour` are
 specified. This must be in the range [0.001, 1000.0]. If unset, the vehicle
 is standard, and this multiple is considered 1.0.

 WARNING: Travel times will be rounded to the nearest second after this
 multiple is applied but before performing any numerical operations, thus,
 a small multiple may result in a loss of precision.

 See also `extra_visit_duration_for_visit_type` below.
        optional double travel_duration_multiple = 11;
        Returns:
        The travelDurationMultiple.

      • getUnloadingPolicyValue

        int getUnloadingPolicyValue()
         Unloading policy enforced on the vehicle.
        .google.cloud.optimization.v1.Vehicle.UnloadingPolicy unloading_policy = 12;
        Returns:
        The enum numeric value on the wire for unloadingPolicy.

      • getUnloadingPolicy

        Vehicle.UnloadingPolicy getUnloadingPolicy()
         Unloading policy enforced on the vehicle.
        .google.cloud.optimization.v1.Vehicle.UnloadingPolicy unloading_policy = 12;
        Returns:
        The unloadingPolicy.

      • getLoadLimitsCount

        int getLoadLimitsCount()
         Capacities of the vehicle (weight, volume, # of pallets for example).
 The keys in the map are the identifiers of the type of load, consistent
 with the keys of the
 [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
 field. If a given key is absent from this map, the corresponding capacity
 is considered to be limitless.
        map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;

      • containsLoadLimits

        boolean containsLoadLimits​(String key)
         Capacities of the vehicle (weight, volume, # of pallets for example).
 The keys in the map are the identifiers of the type of load, consistent
 with the keys of the
 [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
 field. If a given key is absent from this map, the corresponding capacity
 is considered to be limitless.
        map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;

      • getLoadLimitsMap

        Map<String,​Vehicle.LoadLimit> getLoadLimitsMap()
         Capacities of the vehicle (weight, volume, # of pallets for example).
 The keys in the map are the identifiers of the type of load, consistent
 with the keys of the
 [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
 field. If a given key is absent from this map, the corresponding capacity
 is considered to be limitless.
        map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;

      • getLoadLimitsOrDefault

        Vehicle.LoadLimit getLoadLimitsOrDefault​(String key,
                                         Vehicle.LoadLimit defaultValue)
         Capacities of the vehicle (weight, volume, # of pallets for example).
 The keys in the map are the identifiers of the type of load, consistent
 with the keys of the
 [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
 field. If a given key is absent from this map, the corresponding capacity
 is considered to be limitless.
        map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;

      • getLoadLimitsOrThrow

        Vehicle.LoadLimit getLoadLimitsOrThrow​(String key)
         Capacities of the vehicle (weight, volume, # of pallets for example).
 The keys in the map are the identifiers of the type of load, consistent
 with the keys of the
 [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
 field. If a given key is absent from this map, the corresponding capacity
 is considered to be limitless.
        map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;

      • getCostPerHour

        double getCostPerHour()
         Vehicle costs: all costs add up and must be in the same unit as
 [Shipment.penalty_cost][google.cloud.optimization.v1.Shipment.penalty_cost].

 Cost per hour of the vehicle route. This cost is applied to the total time
 taken by the route, and includes travel time, waiting time, and visit time.
 Using `cost_per_hour` instead of just `cost_per_traveled_hour` may result
 in additional latency.
        double cost_per_hour = 16;
        Returns:
        The costPerHour.

      • getCostPerTraveledHour

        double getCostPerTraveledHour()
         Cost per traveled hour of the vehicle route. This cost is applied only to
 travel time taken by the route (i.e., that reported in
 [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]),
 and excludes waiting time and visit time.
        double cost_per_traveled_hour = 17;
        Returns:
        The costPerTraveledHour.

      • getCostPerKilometer

        double getCostPerKilometer()
         Cost per kilometer of the vehicle route. This cost is applied to the
 distance reported in the
 [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions]
 and does not apply to any distance implicitly traveled from the
 `arrival_location` to the `departure_location` of a single `VisitRequest`.
        double cost_per_kilometer = 18;
        Returns:
        The costPerKilometer.

      • getFixedCost

        double getFixedCost()
         Fixed cost applied if this vehicle is used to handle a shipment.
        double fixed_cost = 19;
        Returns:
        The fixedCost.

      • getUsedIfRouteIsEmpty

        boolean getUsedIfRouteIsEmpty()
         This field only applies to vehicles when their route does not serve any
 shipments. It indicates if the vehicle should be considered as used or not
 in this case.

 If true, the vehicle goes from its start to its end location even if it
 doesn't serve any shipments, and time and distance costs resulting from its
 start --> end travel are taken into account.

 Otherwise, it doesn't travel from its start to its end location, and no
 `break_rule` or delay (from `TransitionAttributes`) are scheduled for this
 vehicle. In this case, the vehicle's `ShipmentRoute` doesn't contain any
 information except for the vehicle index and label.
        bool used_if_route_is_empty = 20;
        Returns:
        The usedIfRouteIsEmpty.

      • hasRouteDurationLimit

        boolean hasRouteDurationLimit()
         Limit applied to the total duration of the vehicle's route. In a given
 `OptimizeToursResponse`, the route duration of a vehicle is the
 difference between its `vehicle_end_time` and `vehicle_start_time`.
        .google.cloud.optimization.v1.Vehicle.DurationLimit route_duration_limit = 21;
        Returns:
        Whether the routeDurationLimit field is set.

      • getRouteDurationLimit

        Vehicle.DurationLimit getRouteDurationLimit()
         Limit applied to the total duration of the vehicle's route. In a given
 `OptimizeToursResponse`, the route duration of a vehicle is the
 difference between its `vehicle_end_time` and `vehicle_start_time`.
        .google.cloud.optimization.v1.Vehicle.DurationLimit route_duration_limit = 21;
        Returns:
        The routeDurationLimit.

      • getRouteDurationLimitOrBuilder

        Vehicle.DurationLimitOrBuilder getRouteDurationLimitOrBuilder()
         Limit applied to the total duration of the vehicle's route. In a given
 `OptimizeToursResponse`, the route duration of a vehicle is the
 difference between its `vehicle_end_time` and `vehicle_start_time`.
        .google.cloud.optimization.v1.Vehicle.DurationLimit route_duration_limit = 21;

      • hasTravelDurationLimit

        boolean hasTravelDurationLimit()
         Limit applied to the travel duration of the vehicle's route. In a given
 `OptimizeToursResponse`, the route travel duration is the sum of all its
 [transitions.travel_duration][google.cloud.optimization.v1.ShipmentRoute.Transition.travel_duration].
        .google.cloud.optimization.v1.Vehicle.DurationLimit travel_duration_limit = 22;
        Returns:
        Whether the travelDurationLimit field is set.

      • getTravelDurationLimit

        Vehicle.DurationLimit getTravelDurationLimit()
         Limit applied to the travel duration of the vehicle's route. In a given
 `OptimizeToursResponse`, the route travel duration is the sum of all its
 [transitions.travel_duration][google.cloud.optimization.v1.ShipmentRoute.Transition.travel_duration].
        .google.cloud.optimization.v1.Vehicle.DurationLimit travel_duration_limit = 22;
        Returns:
        The travelDurationLimit.

      • getTravelDurationLimitOrBuilder

        Vehicle.DurationLimitOrBuilder getTravelDurationLimitOrBuilder()
         Limit applied to the travel duration of the vehicle's route. In a given
 `OptimizeToursResponse`, the route travel duration is the sum of all its
 [transitions.travel_duration][google.cloud.optimization.v1.ShipmentRoute.Transition.travel_duration].
        .google.cloud.optimization.v1.Vehicle.DurationLimit travel_duration_limit = 22;

      • hasRouteDistanceLimit

        boolean hasRouteDistanceLimit()
         Limit applied to the total distance of the vehicle's route. In a given
 `OptimizeToursResponse`, the route distance is the sum of all its
 [transitions.travel_distance_meters][google.cloud.optimization.v1.ShipmentRoute.Transition.travel_distance_meters].
        .google.cloud.optimization.v1.DistanceLimit route_distance_limit = 23;
        Returns:
        Whether the routeDistanceLimit field is set.

      • getRouteDistanceLimit

        DistanceLimit getRouteDistanceLimit()
         Limit applied to the total distance of the vehicle's route. In a given
 `OptimizeToursResponse`, the route distance is the sum of all its
 [transitions.travel_distance_meters][google.cloud.optimization.v1.ShipmentRoute.Transition.travel_distance_meters].
        .google.cloud.optimization.v1.DistanceLimit route_distance_limit = 23;
        Returns:
        The routeDistanceLimit.

      • getRouteDistanceLimitOrBuilder

        DistanceLimitOrBuilder getRouteDistanceLimitOrBuilder()
         Limit applied to the total distance of the vehicle's route. In a given
 `OptimizeToursResponse`, the route distance is the sum of all its
 [transitions.travel_distance_meters][google.cloud.optimization.v1.ShipmentRoute.Transition.travel_distance_meters].
        .google.cloud.optimization.v1.DistanceLimit route_distance_limit = 23;

      • getExtraVisitDurationForVisitTypeCount

        int getExtraVisitDurationForVisitTypeCount()
         Specifies a map from visit_types strings to durations. The duration is time
 in addition to
 [VisitRequest.duration][google.cloud.optimization.v1.Shipment.VisitRequest.duration]
 to be taken at visits with the specified `visit_types`. This extra visit
 duration adds cost if `cost_per_hour` is specified. Keys (i.e.
 `visit_types`) cannot be empty strings.

 If a visit request has multiple types, a duration will be added for each
 type in the map.
        map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;

      • containsExtraVisitDurationForVisitType

        boolean containsExtraVisitDurationForVisitType​(String key)
         Specifies a map from visit_types strings to durations. The duration is time
 in addition to
 [VisitRequest.duration][google.cloud.optimization.v1.Shipment.VisitRequest.duration]
 to be taken at visits with the specified `visit_types`. This extra visit
 duration adds cost if `cost_per_hour` is specified. Keys (i.e.
 `visit_types`) cannot be empty strings.

 If a visit request has multiple types, a duration will be added for each
 type in the map.
        map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;

      • getExtraVisitDurationForVisitTypeMap

        Map<String,​com.google.protobuf.Duration> getExtraVisitDurationForVisitTypeMap()
         Specifies a map from visit_types strings to durations. The duration is time
 in addition to
 [VisitRequest.duration][google.cloud.optimization.v1.Shipment.VisitRequest.duration]
 to be taken at visits with the specified `visit_types`. This extra visit
 duration adds cost if `cost_per_hour` is specified. Keys (i.e.
 `visit_types`) cannot be empty strings.

 If a visit request has multiple types, a duration will be added for each
 type in the map.
        map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;

      • getExtraVisitDurationForVisitTypeOrDefault

        com.google.protobuf.Duration getExtraVisitDurationForVisitTypeOrDefault​(String key,
                                                                        com.google.protobuf.Duration defaultValue)
         Specifies a map from visit_types strings to durations. The duration is time
 in addition to
 [VisitRequest.duration][google.cloud.optimization.v1.Shipment.VisitRequest.duration]
 to be taken at visits with the specified `visit_types`. This extra visit
 duration adds cost if `cost_per_hour` is specified. Keys (i.e.
 `visit_types`) cannot be empty strings.

 If a visit request has multiple types, a duration will be added for each
 type in the map.
        map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;

      • getExtraVisitDurationForVisitTypeOrThrow

        com.google.protobuf.Duration getExtraVisitDurationForVisitTypeOrThrow​(String key)
         Specifies a map from visit_types strings to durations. The duration is time
 in addition to
 [VisitRequest.duration][google.cloud.optimization.v1.Shipment.VisitRequest.duration]
 to be taken at visits with the specified `visit_types`. This extra visit
 duration adds cost if `cost_per_hour` is specified. Keys (i.e.
 `visit_types`) cannot be empty strings.

 If a visit request has multiple types, a duration will be added for each
 type in the map.
        map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;

      • hasBreakRule

        boolean hasBreakRule()
         Describes the break schedule to be enforced on this vehicle.
 If empty, no breaks will be scheduled for this vehicle.
        .google.cloud.optimization.v1.BreakRule break_rule = 25;
        Returns:
        Whether the breakRule field is set.

      • getBreakRule

        BreakRule getBreakRule()
         Describes the break schedule to be enforced on this vehicle.
 If empty, no breaks will be scheduled for this vehicle.
        .google.cloud.optimization.v1.BreakRule break_rule = 25;
        Returns:
        The breakRule.

      • getBreakRuleOrBuilder

        BreakRuleOrBuilder getBreakRuleOrBuilder()
         Describes the break schedule to be enforced on this vehicle.
 If empty, no breaks will be scheduled for this vehicle.
        .google.cloud.optimization.v1.BreakRule break_rule = 25;

      • getLabel

        String getLabel()
         Specifies a label for this vehicle. This label is reported in the response
 as the `vehicle_label` of the corresponding
 [ShipmentRoute][google.cloud.optimization.v1.ShipmentRoute].
        string label = 27;
        Returns:
        The label.

      • getLabelBytes

        com.google.protobuf.ByteString getLabelBytes()
         Specifies a label for this vehicle. This label is reported in the response
 as the `vehicle_label` of the corresponding
 [ShipmentRoute][google.cloud.optimization.v1.ShipmentRoute].
        string label = 27;
        Returns:
        The bytes for label.

      • getIgnore

        boolean getIgnore()
         If true, `used_if_route_is_empty` must be false, and this vehicle will
 remain unused.

 If a shipment is performed by an ignored vehicle in
 `injected_first_solution_routes`, it is skipped in the first solution but
 is free to be performed in the response.

 If a shipment is performed by an ignored vehicle in
 `injected_solution_constraint` and any related pickup/delivery is
 constrained to remain on the vehicle (i.e., not relaxed to level
 `RELAX_ALL_AFTER_THRESHOLD`), it is skipped in the response.
 If a shipment has a non-empty `allowed_vehicle_indices` field and all of
 the allowed vehicles are ignored, it is skipped in the response.
        bool ignore = 28;
        Returns:
        The ignore.

      • getBreakRuleIndicesList

        @Deprecated
List<Integer> getBreakRuleIndicesList()
        Deprecated.
        google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1454
         Deprecated: No longer used.
 Indices in the `break_rule` field in the source
 [ShipmentModel][google.cloud.optimization.v1.ShipmentModel]. They
 correspond to break rules enforced on the vehicle.

 As of 2018/03, at most one rule index per vehicle can be specified.
        repeated int32 break_rule_indices = 29 [deprecated = true];
        Returns:
        A list containing the breakRuleIndices.

      • getBreakRuleIndicesCount

        @Deprecated
int getBreakRuleIndicesCount()
        Deprecated.
        google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1454
         Deprecated: No longer used.
 Indices in the `break_rule` field in the source
 [ShipmentModel][google.cloud.optimization.v1.ShipmentModel]. They
 correspond to break rules enforced on the vehicle.

 As of 2018/03, at most one rule index per vehicle can be specified.
        repeated int32 break_rule_indices = 29 [deprecated = true];
        Returns:
        The count of breakRuleIndices.

      • getBreakRuleIndices

        @Deprecated
int getBreakRuleIndices​(int index)
        Deprecated.
        google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1454
         Deprecated: No longer used.
 Indices in the `break_rule` field in the source
 [ShipmentModel][google.cloud.optimization.v1.ShipmentModel]. They
 correspond to break rules enforced on the vehicle.

 As of 2018/03, at most one rule index per vehicle can be specified.
        repeated int32 break_rule_indices = 29 [deprecated = true];
        Parameters:
        index - The index of the element to return.
        Returns:
        The breakRuleIndices at the given index.

      • getCapacitiesList

        @Deprecated
List<CapacityQuantity> getCapacitiesList()
        Deprecated.
         Deprecated: Use
 [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];

      • getCapacities

        @Deprecated
CapacityQuantity getCapacities​(int index)
        Deprecated.
         Deprecated: Use
 [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];

      • getCapacitiesCount

        @Deprecated
int getCapacitiesCount()
        Deprecated.
         Deprecated: Use
 [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];

      • getCapacitiesOrBuilderList

        @Deprecated
List<? extends CapacityQuantityOrBuilder> getCapacitiesOrBuilderList()
        Deprecated.
         Deprecated: Use
 [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];

      • getCapacitiesOrBuilder

        @Deprecated
CapacityQuantityOrBuilder getCapacitiesOrBuilder​(int index)
        Deprecated.
         Deprecated: Use
 [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];

      • getStartLoadIntervalsList

        @Deprecated
List<CapacityQuantityInterval> getStartLoadIntervalsList()
        Deprecated.
         Deprecated: Use
 [Vehicle.LoadLimit.start_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.start_load_interval]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

      • getStartLoadIntervals

        @Deprecated
CapacityQuantityInterval getStartLoadIntervals​(int index)
        Deprecated.
         Deprecated: Use
 [Vehicle.LoadLimit.start_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.start_load_interval]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

      • getStartLoadIntervalsCount

        @Deprecated
int getStartLoadIntervalsCount()
        Deprecated.
         Deprecated: Use
 [Vehicle.LoadLimit.start_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.start_load_interval]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

      • getStartLoadIntervalsOrBuilderList

        @Deprecated
List<? extends CapacityQuantityIntervalOrBuilder> getStartLoadIntervalsOrBuilderList()
        Deprecated.
         Deprecated: Use
 [Vehicle.LoadLimit.start_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.start_load_interval]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

      • getStartLoadIntervalsOrBuilder

        @Deprecated
CapacityQuantityIntervalOrBuilder getStartLoadIntervalsOrBuilder​(int index)
        Deprecated.
         Deprecated: Use
 [Vehicle.LoadLimit.start_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.start_load_interval]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

      • getEndLoadIntervalsList

        @Deprecated
List<CapacityQuantityInterval> getEndLoadIntervalsList()
        Deprecated.
         Deprecated: Use
 [Vehicle.LoadLimit.end_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.end_load_interval]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

      • getEndLoadIntervals

        @Deprecated
CapacityQuantityInterval getEndLoadIntervals​(int index)
        Deprecated.
         Deprecated: Use
 [Vehicle.LoadLimit.end_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.end_load_interval]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

      • getEndLoadIntervalsCount

        @Deprecated
int getEndLoadIntervalsCount()
        Deprecated.
         Deprecated: Use
 [Vehicle.LoadLimit.end_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.end_load_interval]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

      • getEndLoadIntervalsOrBuilderList

        @Deprecated
List<? extends CapacityQuantityIntervalOrBuilder> getEndLoadIntervalsOrBuilderList()
        Deprecated.
         Deprecated: Use
 [Vehicle.LoadLimit.end_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.end_load_interval]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

      • getEndLoadIntervalsOrBuilder

        @Deprecated
CapacityQuantityIntervalOrBuilder getEndLoadIntervalsOrBuilder​(int index)
        Deprecated.
         Deprecated: Use
 [Vehicle.LoadLimit.end_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.end_load_interval]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];