Interface VehicleOrBuilder (1.10.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 1.76.0 (latest)
- 1.74.0
- 1.73.0
- 1.72.0
- 1.71.0
- 1.70.0
- 1.68.0
- 1.66.0
- 1.65.0
- 1.62.0
- 1.61.0
- 1.60.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.14
- 0.1.2
publicinterface VehicleOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsExtraVisitDurationForVisitType(String key)
publicabstractbooleancontainsExtraVisitDurationForVisitType(Stringkey) Specifies a map from visit_types strings to durations. The duration is time
in addition to
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;
containsLoadLimits(String key)
publicabstractbooleancontainsLoadLimits(Stringkey)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 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;
getBreakRule()
publicabstractBreakRulegetBreakRule()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;
BreakRule
The breakRule.
getBreakRuleIndices(int index) (deprecated)
publicabstractintgetBreakRuleIndices(intindex)Deprecated. google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1443
Deprecated: No longer used.
Indices in the break_rule field in the source
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];
int
The breakRuleIndices at the given index.
getBreakRuleIndicesCount() (deprecated)
publicabstractintgetBreakRuleIndicesCount()Deprecated. google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1443
Deprecated: No longer used.
Indices in the break_rule field in the source
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];
int
The count of breakRuleIndices.
getBreakRuleIndicesList() (deprecated)
publicabstractList<Integer>getBreakRuleIndicesList()Deprecated. google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1443
Deprecated: No longer used.
Indices in the break_rule field in the source
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];
getBreakRuleOrBuilder()
publicabstractBreakRuleOrBuildergetBreakRuleOrBuilder()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;
getCapacities(int index)
publicabstractCapacityQuantitygetCapacities(intindex)Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
getCapacitiesCount()
publicabstractintgetCapacitiesCount()Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
getCapacitiesList()
publicabstractList<CapacityQuantity>getCapacitiesList()Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
getCapacitiesOrBuilder(int index)
publicabstractCapacityQuantityOrBuildergetCapacitiesOrBuilder(intindex)Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
getCapacitiesOrBuilderList()
publicabstractList<?extendsCapacityQuantityOrBuilder>getCapacitiesOrBuilderList()Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
List<? extends com.google.cloud.optimization.v1.CapacityQuantityOrBuilder>
getCostPerHour()
publicabstractdoublegetCostPerHour() Vehicle costs: all costs add up and must be in the same unit as
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;
double
The costPerHour.
getCostPerKilometer()
publicabstractdoublegetCostPerKilometer() Cost per kilometer of the vehicle route. This cost is applied to the
distance reported in the
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;
double
The costPerKilometer.
getCostPerTraveledHour()
publicabstractdoublegetCostPerTraveledHour()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), and excludes waiting time and visit time.
double cost_per_traveled_hour = 17;
double
The costPerTraveledHour.
getEndLoadIntervals(int index)
publicabstractCapacityQuantityIntervalgetEndLoadIntervals(intindex)Deprecated: Use Vehicle.LoadLimit.end_load_interval instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];
getEndLoadIntervalsCount()
publicabstractintgetEndLoadIntervalsCount()Deprecated: Use Vehicle.LoadLimit.end_load_interval instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];
getEndLoadIntervalsList()
publicabstractList<CapacityQuantityInterval>getEndLoadIntervalsList()Deprecated: Use Vehicle.LoadLimit.end_load_interval instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];
getEndLoadIntervalsOrBuilder(int index)
publicabstractCapacityQuantityIntervalOrBuildergetEndLoadIntervalsOrBuilder(intindex)Deprecated: Use Vehicle.LoadLimit.end_load_interval instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];
getEndLoadIntervalsOrBuilderList()
publicabstractList<?extendsCapacityQuantityIntervalOrBuilder>getEndLoadIntervalsOrBuilderList()Deprecated: Use Vehicle.LoadLimit.end_load_interval instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];
List<? extends com.google.cloud.optimization.v1.CapacityQuantityIntervalOrBuilder>
getEndLocation()
publicabstractLatLnggetEndLocation() 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;
com.google.type.LatLng
The endLocation.
getEndLocationOrBuilder()
publicabstractLatLngOrBuildergetEndLocationOrBuilder() 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;
com.google.type.LatLngOrBuilder
getEndTags(int index)
publicabstractStringgetEndTags(intindex)Specifies tags attached to the end of the vehicle's route. Empty or duplicate strings are not allowed.
repeated string end_tags = 8;
String
The endTags at the given index.
getEndTagsBytes(int index)
publicabstractByteStringgetEndTagsBytes(intindex)Specifies tags attached to the end of the vehicle's route. Empty or duplicate strings are not allowed.
repeated string end_tags = 8;
ByteString
The bytes of the endTags at the given index.
getEndTagsCount()
publicabstractintgetEndTagsCount()Specifies tags attached to the end of the vehicle's route. Empty or duplicate strings are not allowed.
repeated string end_tags = 8;
int
The count of endTags.
getEndTagsList()
publicabstractList<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;
getEndTimeWindows(int index)
publicabstractTimeWindowgetEndTimeWindows(intindex) Time windows during which the vehicle may arrive at its end location.
They must be within the global time limits (see
ShipmentModel.global_*
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()
publicabstractintgetEndTimeWindowsCount() Time windows during which the vehicle may arrive at its end location.
They must be within the global time limits (see
ShipmentModel.global_*
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;
getEndTimeWindowsList()
publicabstractList<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_*
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(int index)
publicabstractTimeWindowOrBuildergetEndTimeWindowsOrBuilder(intindex) Time windows during which the vehicle may arrive at its end location.
They must be within the global time limits (see
ShipmentModel.global_*
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()
publicabstractList<?extendsTimeWindowOrBuilder>getEndTimeWindowsOrBuilderList() Time windows during which the vehicle may arrive at its end location.
They must be within the global time limits (see
ShipmentModel.global_*
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;
List<? extends com.google.cloud.optimization.v1.TimeWindowOrBuilder>
getEndWaypoint()
publicabstractWaypointgetEndWaypoint() 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;
Waypoint
The endWaypoint.
getEndWaypointOrBuilder()
publicabstractWaypointOrBuildergetEndWaypointOrBuilder() 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;
getExtraVisitDurationForVisitType()
publicabstractMap<String,Duration>getExtraVisitDurationForVisitType()Use #getExtraVisitDurationForVisitTypeMap() instead.
getExtraVisitDurationForVisitTypeCount()
publicabstractintgetExtraVisitDurationForVisitTypeCount() Specifies a map from visit_types strings to durations. The duration is time
in addition to
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()
publicabstractMap<String,Duration>getExtraVisitDurationForVisitTypeMap() Specifies a map from visit_types strings to durations. The duration is time
in addition to
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(String key, Duration defaultValue)
publicabstractDurationgetExtraVisitDurationForVisitTypeOrDefault(Stringkey,DurationdefaultValue) Specifies a map from visit_types strings to durations. The duration is time
in addition to
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(String key)
publicabstractDurationgetExtraVisitDurationForVisitTypeOrThrow(Stringkey) Specifies a map from visit_types strings to durations. The duration is time
in addition to
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;
getFixedCost()
publicabstractdoublegetFixedCost()Fixed cost applied if this vehicle is used to handle a shipment.
double fixed_cost = 19;
double
The fixedCost.
getIgnore()
publicabstractbooleangetIgnore() 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;
boolean
The ignore.
getLabel()
publicabstractStringgetLabel() Specifies a label for this vehicle. This label is reported in the response
as the vehicle_label of the corresponding
ShipmentRoute.
string label = 27;
String
The label.
getLabelBytes()
publicabstractByteStringgetLabelBytes() Specifies a label for this vehicle. This label is reported in the response
as the vehicle_label of the corresponding
ShipmentRoute.
string label = 27;
ByteString
The bytes for label.
getLoadLimits()
publicabstractMap<String,Vehicle.LoadLimit>getLoadLimits()Use #getLoadLimitsMap() instead.
getLoadLimitsCount()
publicabstractintgetLoadLimitsCount()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 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()
publicabstractMap<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 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(String key, Vehicle.LoadLimit defaultValue)
publicabstractVehicle.LoadLimitgetLoadLimitsOrDefault(Stringkey,Vehicle.LoadLimitdefaultValue)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 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(String key)
publicabstractVehicle.LoadLimitgetLoadLimitsOrThrow(Stringkey)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 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;
getRouteDistanceLimit()
publicabstractDistanceLimitgetRouteDistanceLimit() 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.DistanceLimit route_distance_limit = 23;
DistanceLimit
The routeDistanceLimit.
getRouteDistanceLimitOrBuilder()
publicabstractDistanceLimitOrBuildergetRouteDistanceLimitOrBuilder() 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.DistanceLimit route_distance_limit = 23;
getRouteDurationLimit()
publicabstractVehicle.DurationLimitgetRouteDurationLimit() 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;
Vehicle.DurationLimit
The routeDurationLimit.
getRouteDurationLimitOrBuilder()
publicabstractVehicle.DurationLimitOrBuildergetRouteDurationLimitOrBuilder() 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;
getStartLoadIntervals(int index)
publicabstractCapacityQuantityIntervalgetStartLoadIntervals(intindex)Deprecated: Use Vehicle.LoadLimit.start_load_interval instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];
getStartLoadIntervalsCount()
publicabstractintgetStartLoadIntervalsCount()Deprecated: Use Vehicle.LoadLimit.start_load_interval instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];
getStartLoadIntervalsList()
publicabstractList<CapacityQuantityInterval>getStartLoadIntervalsList()Deprecated: Use Vehicle.LoadLimit.start_load_interval instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];
getStartLoadIntervalsOrBuilder(int index)
publicabstractCapacityQuantityIntervalOrBuildergetStartLoadIntervalsOrBuilder(intindex)Deprecated: Use Vehicle.LoadLimit.start_load_interval instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];
getStartLoadIntervalsOrBuilderList()
publicabstractList<?extendsCapacityQuantityIntervalOrBuilder>getStartLoadIntervalsOrBuilderList()Deprecated: Use Vehicle.LoadLimit.start_load_interval instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];
List<? extends com.google.cloud.optimization.v1.CapacityQuantityIntervalOrBuilder>
getStartLocation()
publicabstractLatLnggetStartLocation() 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;
com.google.type.LatLng
The startLocation.
getStartLocationOrBuilder()
publicabstractLatLngOrBuildergetStartLocationOrBuilder() 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;
com.google.type.LatLngOrBuilder
getStartTags(int index)
publicabstractStringgetStartTags(intindex)Specifies tags attached to the start of the vehicle's route. Empty or duplicate strings are not allowed.
repeated string start_tags = 7;
String
The startTags at the given index.
getStartTagsBytes(int index)
publicabstractByteStringgetStartTagsBytes(intindex)Specifies tags attached to the start of the vehicle's route. Empty or duplicate strings are not allowed.
repeated string start_tags = 7;
ByteString
The bytes of the startTags at the given index.
getStartTagsCount()
publicabstractintgetStartTagsCount()Specifies tags attached to the start of the vehicle's route. Empty or duplicate strings are not allowed.
repeated string start_tags = 7;
int
The count of startTags.
getStartTagsList()
publicabstractList<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;
getStartTimeWindows(int index)
publicabstractTimeWindowgetStartTimeWindows(intindex) Time windows during which the vehicle may depart its start location.
They must be within the global time limits (see
ShipmentModel.global_*
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()
publicabstractintgetStartTimeWindowsCount() Time windows during which the vehicle may depart its start location.
They must be within the global time limits (see
ShipmentModel.global_*
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;
getStartTimeWindowsList()
publicabstractList<TimeWindow>getStartTimeWindowsList() Time windows during which the vehicle may depart its start location.
They must be within the global time limits (see
ShipmentModel.global_*
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(int index)
publicabstractTimeWindowOrBuildergetStartTimeWindowsOrBuilder(intindex) Time windows during which the vehicle may depart its start location.
They must be within the global time limits (see
ShipmentModel.global_*
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()
publicabstractList<?extendsTimeWindowOrBuilder>getStartTimeWindowsOrBuilderList() Time windows during which the vehicle may depart its start location.
They must be within the global time limits (see
ShipmentModel.global_*
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;
List<? extends com.google.cloud.optimization.v1.TimeWindowOrBuilder>
getStartWaypoint()
publicabstractWaypointgetStartWaypoint() 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;
Waypoint
The startWaypoint.
getStartWaypointOrBuilder()
publicabstractWaypointOrBuildergetStartWaypointOrBuilder() 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;
getTravelDurationLimit()
publicabstractVehicle.DurationLimitgetTravelDurationLimit() 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.Vehicle.DurationLimit travel_duration_limit = 22;
Vehicle.DurationLimit
The travelDurationLimit.
getTravelDurationLimitOrBuilder()
publicabstractVehicle.DurationLimitOrBuildergetTravelDurationLimitOrBuilder() 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.Vehicle.DurationLimit travel_duration_limit = 22;
getTravelDurationMultiple()
publicabstractdoublegetTravelDurationMultiple() 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;
double
The travelDurationMultiple.
getTravelMode()
publicabstractVehicle.TravelModegetTravelMode() 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;
Vehicle.TravelMode
The travelMode.
getTravelModeValue()
publicabstractintgetTravelModeValue() 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;
int
The enum numeric value on the wire for travelMode.
getUnloadingPolicy()
publicabstractVehicle.UnloadingPolicygetUnloadingPolicy()Unloading policy enforced on the vehicle.
.google.cloud.optimization.v1.Vehicle.UnloadingPolicy unloading_policy = 12;
Vehicle.UnloadingPolicy
The unloadingPolicy.
getUnloadingPolicyValue()
publicabstractintgetUnloadingPolicyValue()Unloading policy enforced on the vehicle.
.google.cloud.optimization.v1.Vehicle.UnloadingPolicy unloading_policy = 12;
int
The enum numeric value on the wire for unloadingPolicy.
getUsedIfRouteIsEmpty()
publicabstractbooleangetUsedIfRouteIsEmpty() 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;
boolean
The usedIfRouteIsEmpty.
hasBreakRule()
publicabstractbooleanhasBreakRule()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;
boolean
Whether the breakRule field is set.
hasEndLocation()
publicabstractbooleanhasEndLocation() 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;
boolean
Whether the endLocation field is set.
hasEndWaypoint()
publicabstractbooleanhasEndWaypoint() 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;
boolean
Whether the endWaypoint field is set.
hasRouteDistanceLimit()
publicabstractbooleanhasRouteDistanceLimit() 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.DistanceLimit route_distance_limit = 23;
boolean
Whether the routeDistanceLimit field is set.
hasRouteDurationLimit()
publicabstractbooleanhasRouteDurationLimit() 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;
boolean
Whether the routeDurationLimit field is set.
hasStartLocation()
publicabstractbooleanhasStartLocation() 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;
boolean
Whether the startLocation field is set.
hasStartWaypoint()
publicabstractbooleanhasStartWaypoint() 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;
boolean
Whether the startWaypoint field is set.
hasTravelDurationLimit()
publicabstractbooleanhasTravelDurationLimit() 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.Vehicle.DurationLimit travel_duration_limit = 22;
boolean
Whether the travelDurationLimit field is set.
hasTravelDurationMultiple()
publicabstractbooleanhasTravelDurationMultiple() 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;
boolean
Whether the travelDurationMultiple field is set.