Class Vehicle.Builder (1.3.0)

public static final class Vehicle.Builder extends GeneratedMessageV3.Builder<Vehicle.Builder> implements VehicleOrBuilder

Models a vehicle in a shipment problem. Solving a shipment problem will build a route starting from start_location and ending at end_location for this vehicle. A route is a sequence of visits (see ShipmentRoute).

Protobuf type google.cloud.optimization.v1.Vehicle

Implements

VehicleOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllBreakRuleIndices(Iterable<? extends Integer> values) (deprecated)

public Vehicle.Builder addAllBreakRuleIndices(Iterable<? extends Integer> values)

Deprecated. google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1379

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];

Parameter
NameDescription
valuesIterable<? extends java.lang.Integer>

The breakRuleIndices to add.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

addAllCapacities(Iterable<? extends CapacityQuantity> values)

public Vehicle.Builder addAllCapacities(Iterable<? extends CapacityQuantity> values)

Deprecated: Use [Vehicle.load_limits][] instead.

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.optimization.v1.CapacityQuantity>
Returns
TypeDescription
Vehicle.Builder

addAllEndLoadIntervals(Iterable<? extends CapacityQuantityInterval> values)

public Vehicle.Builder addAllEndLoadIntervals(Iterable<? extends CapacityQuantityInterval> values)

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.optimization.v1.CapacityQuantityInterval>
Returns
TypeDescription
Vehicle.Builder

addAllEndTags(Iterable<String> values)

public Vehicle.Builder addAllEndTags(Iterable<String> values)

Specifies tags attached to the end of the vehicle's route. Empty or duplicate strings are not allowed.

repeated string end_tags = 8;

Parameter
NameDescription
valuesIterable<String>

The endTags to add.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

addAllEndTimeWindows(Iterable<? extends TimeWindow> values)

public Vehicle.Builder addAllEndTimeWindows(Iterable<? extends TimeWindow> values)

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;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.optimization.v1.TimeWindow>
Returns
TypeDescription
Vehicle.Builder

addAllStartLoadIntervals(Iterable<? extends CapacityQuantityInterval> values)

public Vehicle.Builder addAllStartLoadIntervals(Iterable<? extends CapacityQuantityInterval> values)

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.optimization.v1.CapacityQuantityInterval>
Returns
TypeDescription
Vehicle.Builder

addAllStartTags(Iterable<String> values)

public Vehicle.Builder addAllStartTags(Iterable<String> values)

Specifies tags attached to the start of the vehicle's route. Empty or duplicate strings are not allowed.

repeated string start_tags = 7;

Parameter
NameDescription
valuesIterable<String>

The startTags to add.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

addAllStartTimeWindows(Iterable<? extends TimeWindow> values)

public Vehicle.Builder addAllStartTimeWindows(Iterable<? extends TimeWindow> values)

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;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.optimization.v1.TimeWindow>
Returns
TypeDescription
Vehicle.Builder

addBreakRuleIndices(int value) (deprecated)

public Vehicle.Builder addBreakRuleIndices(int value)

Deprecated. google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1379

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];

Parameter
NameDescription
valueint

The breakRuleIndices to add.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

addCapacities(CapacityQuantity value)

public Vehicle.Builder addCapacities(CapacityQuantity value)

Deprecated: Use [Vehicle.load_limits][] instead.

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

Parameter
NameDescription
valueCapacityQuantity
Returns
TypeDescription
Vehicle.Builder

addCapacities(CapacityQuantity.Builder builderForValue)

public Vehicle.Builder addCapacities(CapacityQuantity.Builder builderForValue)

Deprecated: Use [Vehicle.load_limits][] instead.

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

Parameter
NameDescription
builderForValueCapacityQuantity.Builder
Returns
TypeDescription
Vehicle.Builder

addCapacities(int index, CapacityQuantity value)

public Vehicle.Builder addCapacities(int index, CapacityQuantity value)

Deprecated: Use [Vehicle.load_limits][] instead.

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

Parameters
NameDescription
indexint
valueCapacityQuantity
Returns
TypeDescription
Vehicle.Builder

addCapacities(int index, CapacityQuantity.Builder builderForValue)

public Vehicle.Builder addCapacities(int index, CapacityQuantity.Builder builderForValue)

Deprecated: Use [Vehicle.load_limits][] instead.

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

Parameters
NameDescription
indexint
builderForValueCapacityQuantity.Builder
Returns
TypeDescription
Vehicle.Builder

addCapacitiesBuilder()

public CapacityQuantity.Builder addCapacitiesBuilder()

Deprecated: Use [Vehicle.load_limits][] instead.

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

Returns
TypeDescription
CapacityQuantity.Builder

addCapacitiesBuilder(int index)

public CapacityQuantity.Builder addCapacitiesBuilder(int index)

Deprecated: Use [Vehicle.load_limits][] instead.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantity.Builder

addEndLoadIntervals(CapacityQuantityInterval value)

public Vehicle.Builder addEndLoadIntervals(CapacityQuantityInterval value)

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Parameter
NameDescription
valueCapacityQuantityInterval
Returns
TypeDescription
Vehicle.Builder

addEndLoadIntervals(CapacityQuantityInterval.Builder builderForValue)

public Vehicle.Builder addEndLoadIntervals(CapacityQuantityInterval.Builder builderForValue)

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Parameter
NameDescription
builderForValueCapacityQuantityInterval.Builder
Returns
TypeDescription
Vehicle.Builder

addEndLoadIntervals(int index, CapacityQuantityInterval value)

public Vehicle.Builder addEndLoadIntervals(int index, CapacityQuantityInterval value)

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Parameters
NameDescription
indexint
valueCapacityQuantityInterval
Returns
TypeDescription
Vehicle.Builder

addEndLoadIntervals(int index, CapacityQuantityInterval.Builder builderForValue)

public Vehicle.Builder addEndLoadIntervals(int index, CapacityQuantityInterval.Builder builderForValue)

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Parameters
NameDescription
indexint
builderForValueCapacityQuantityInterval.Builder
Returns
TypeDescription
Vehicle.Builder

addEndLoadIntervalsBuilder()

public CapacityQuantityInterval.Builder addEndLoadIntervalsBuilder()

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Returns
TypeDescription
CapacityQuantityInterval.Builder

addEndLoadIntervalsBuilder(int index)

public CapacityQuantityInterval.Builder addEndLoadIntervalsBuilder(int index)

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantityInterval.Builder

addEndTags(String value)

public Vehicle.Builder addEndTags(String value)

Specifies tags attached to the end of the vehicle's route. Empty or duplicate strings are not allowed.

repeated string end_tags = 8;

Parameter
NameDescription
valueString

The endTags to add.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

addEndTagsBytes(ByteString value)

public Vehicle.Builder addEndTagsBytes(ByteString value)

Specifies tags attached to the end of the vehicle's route. Empty or duplicate strings are not allowed.

repeated string end_tags = 8;

Parameter
NameDescription
valueByteString

The bytes of the endTags to add.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

addEndTimeWindows(TimeWindow value)

public Vehicle.Builder addEndTimeWindows(TimeWindow value)

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;

Parameter
NameDescription
valueTimeWindow
Returns
TypeDescription
Vehicle.Builder

addEndTimeWindows(TimeWindow.Builder builderForValue)

public Vehicle.Builder addEndTimeWindows(TimeWindow.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueTimeWindow.Builder
Returns
TypeDescription
Vehicle.Builder

addEndTimeWindows(int index, TimeWindow value)

public Vehicle.Builder addEndTimeWindows(int index, TimeWindow value)

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;

Parameters
NameDescription
indexint
valueTimeWindow
Returns
TypeDescription
Vehicle.Builder

addEndTimeWindows(int index, TimeWindow.Builder builderForValue)

public Vehicle.Builder addEndTimeWindows(int index, TimeWindow.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueTimeWindow.Builder
Returns
TypeDescription
Vehicle.Builder

addEndTimeWindowsBuilder()

public TimeWindow.Builder addEndTimeWindowsBuilder()

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;

Returns
TypeDescription
TimeWindow.Builder

addEndTimeWindowsBuilder(int index)

public TimeWindow.Builder addEndTimeWindowsBuilder(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_* 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;

Parameter
NameDescription
indexint
Returns
TypeDescription
TimeWindow.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Vehicle.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Vehicle.Builder
Overrides

addStartLoadIntervals(CapacityQuantityInterval value)

public Vehicle.Builder addStartLoadIntervals(CapacityQuantityInterval value)

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Parameter
NameDescription
valueCapacityQuantityInterval
Returns
TypeDescription
Vehicle.Builder

addStartLoadIntervals(CapacityQuantityInterval.Builder builderForValue)

public Vehicle.Builder addStartLoadIntervals(CapacityQuantityInterval.Builder builderForValue)

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Parameter
NameDescription
builderForValueCapacityQuantityInterval.Builder
Returns
TypeDescription
Vehicle.Builder

addStartLoadIntervals(int index, CapacityQuantityInterval value)

public Vehicle.Builder addStartLoadIntervals(int index, CapacityQuantityInterval value)

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Parameters
NameDescription
indexint
valueCapacityQuantityInterval
Returns
TypeDescription
Vehicle.Builder

addStartLoadIntervals(int index, CapacityQuantityInterval.Builder builderForValue)

public Vehicle.Builder addStartLoadIntervals(int index, CapacityQuantityInterval.Builder builderForValue)

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Parameters
NameDescription
indexint
builderForValueCapacityQuantityInterval.Builder
Returns
TypeDescription
Vehicle.Builder

addStartLoadIntervalsBuilder()

public CapacityQuantityInterval.Builder addStartLoadIntervalsBuilder()

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Returns
TypeDescription
CapacityQuantityInterval.Builder

addStartLoadIntervalsBuilder(int index)

public CapacityQuantityInterval.Builder addStartLoadIntervalsBuilder(int index)

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantityInterval.Builder

addStartTags(String value)

public Vehicle.Builder addStartTags(String value)

Specifies tags attached to the start of the vehicle's route. Empty or duplicate strings are not allowed.

repeated string start_tags = 7;

Parameter
NameDescription
valueString

The startTags to add.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

addStartTagsBytes(ByteString value)

public Vehicle.Builder addStartTagsBytes(ByteString value)

Specifies tags attached to the start of the vehicle's route. Empty or duplicate strings are not allowed.

repeated string start_tags = 7;

Parameter
NameDescription
valueByteString

The bytes of the startTags to add.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

addStartTimeWindows(TimeWindow value)

public Vehicle.Builder addStartTimeWindows(TimeWindow value)

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;

Parameter
NameDescription
valueTimeWindow
Returns
TypeDescription
Vehicle.Builder

addStartTimeWindows(TimeWindow.Builder builderForValue)

public Vehicle.Builder addStartTimeWindows(TimeWindow.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueTimeWindow.Builder
Returns
TypeDescription
Vehicle.Builder

addStartTimeWindows(int index, TimeWindow value)

public Vehicle.Builder addStartTimeWindows(int index, TimeWindow value)

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;

Parameters
NameDescription
indexint
valueTimeWindow
Returns
TypeDescription
Vehicle.Builder

addStartTimeWindows(int index, TimeWindow.Builder builderForValue)

public Vehicle.Builder addStartTimeWindows(int index, TimeWindow.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueTimeWindow.Builder
Returns
TypeDescription
Vehicle.Builder

addStartTimeWindowsBuilder()

public TimeWindow.Builder addStartTimeWindowsBuilder()

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;

Returns
TypeDescription
TimeWindow.Builder

addStartTimeWindowsBuilder(int index)

public TimeWindow.Builder addStartTimeWindowsBuilder(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
TimeWindow.Builder

build()

public Vehicle build()
Returns
TypeDescription
Vehicle

buildPartial()

public Vehicle buildPartial()
Returns
TypeDescription
Vehicle

clear()

public Vehicle.Builder clear()
Returns
TypeDescription
Vehicle.Builder
Overrides

clearBreakRule()

public Vehicle.Builder clearBreakRule()

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
TypeDescription
Vehicle.Builder

clearBreakRuleIndices() (deprecated)

public Vehicle.Builder clearBreakRuleIndices()

Deprecated. google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1379

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];

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

clearCapacities()

public Vehicle.Builder clearCapacities()

Deprecated: Use [Vehicle.load_limits][] instead.

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

Returns
TypeDescription
Vehicle.Builder

clearCostPerHour()

public Vehicle.Builder clearCostPerHour()

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;

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

clearCostPerKilometer()

public Vehicle.Builder clearCostPerKilometer()

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;

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

clearCostPerTraveledHour()

public Vehicle.Builder clearCostPerTraveledHour()

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;

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

clearEndLoadIntervals()

public Vehicle.Builder clearEndLoadIntervals()

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Returns
TypeDescription
Vehicle.Builder

clearEndLocation()

public Vehicle.Builder clearEndLocation()

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
TypeDescription
Vehicle.Builder

clearEndTags()

public Vehicle.Builder clearEndTags()

Specifies tags attached to the end of the vehicle's route. Empty or duplicate strings are not allowed.

repeated string end_tags = 8;

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

clearEndTimeWindows()

public Vehicle.Builder clearEndTimeWindows()

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;

Returns
TypeDescription
Vehicle.Builder

clearEndWaypoint()

public Vehicle.Builder clearEndWaypoint()

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
TypeDescription
Vehicle.Builder

clearExtraVisitDurationForVisitType()

public Vehicle.Builder clearExtraVisitDurationForVisitType()
Returns
TypeDescription
Vehicle.Builder

clearField(Descriptors.FieldDescriptor field)

public Vehicle.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Vehicle.Builder
Overrides

clearFixedCost()

public Vehicle.Builder clearFixedCost()

Fixed cost applied if this vehicle is used to handle a shipment.

double fixed_cost = 19;

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

clearIgnore()

public Vehicle.Builder clearIgnore()

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
TypeDescription
Vehicle.Builder

This builder for chaining.

clearLabel()

public Vehicle.Builder clearLabel()

Specifies a label for this vehicle. This label is reported in the response as the vehicle_label of the corresponding ShipmentRoute.

string label = 27;

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

clearLoadLimits()

public Vehicle.Builder clearLoadLimits()
Returns
TypeDescription
Vehicle.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Vehicle.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Vehicle.Builder
Overrides

clearRouteDistanceLimit()

public Vehicle.Builder clearRouteDistanceLimit()

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;

Returns
TypeDescription
Vehicle.Builder

clearRouteDurationLimit()

public Vehicle.Builder clearRouteDurationLimit()

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
TypeDescription
Vehicle.Builder

clearStartLoadIntervals()

public Vehicle.Builder clearStartLoadIntervals()

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Returns
TypeDescription
Vehicle.Builder

clearStartLocation()

public Vehicle.Builder clearStartLocation()

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
TypeDescription
Vehicle.Builder

clearStartTags()

public Vehicle.Builder clearStartTags()

Specifies tags attached to the start of the vehicle's route. Empty or duplicate strings are not allowed.

repeated string start_tags = 7;

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

clearStartTimeWindows()

public Vehicle.Builder clearStartTimeWindows()

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;

Returns
TypeDescription
Vehicle.Builder

clearStartWaypoint()

public Vehicle.Builder clearStartWaypoint()

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
TypeDescription
Vehicle.Builder

clearTravelDurationLimit()

public Vehicle.Builder clearTravelDurationLimit()

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;

Returns
TypeDescription
Vehicle.Builder

clearTravelDurationMultiple()

public Vehicle.Builder clearTravelDurationMultiple()

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
TypeDescription
Vehicle.Builder

This builder for chaining.

clearTravelMode()

public Vehicle.Builder clearTravelMode()

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
TypeDescription
Vehicle.Builder

This builder for chaining.

clearUnloadingPolicy()

public Vehicle.Builder clearUnloadingPolicy()

Unloading policy enforced on the vehicle.

.google.cloud.optimization.v1.Vehicle.UnloadingPolicy unloading_policy = 12;

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

clearUsedIfRouteIsEmpty()

public Vehicle.Builder clearUsedIfRouteIsEmpty()

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
TypeDescription
Vehicle.Builder

This builder for chaining.

clone()

public Vehicle.Builder clone()
Returns
TypeDescription
Vehicle.Builder
Overrides

containsExtraVisitDurationForVisitType(String key)

public boolean containsExtraVisitDurationForVisitType(String key)

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsLoadLimits(String key)

public 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 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;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getBreakRule()

public 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
TypeDescription
BreakRule

The breakRule.

getBreakRuleBuilder()

public BreakRule.Builder getBreakRuleBuilder()

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
TypeDescription
BreakRule.Builder

getBreakRuleIndices(int index) (deprecated)

public int getBreakRuleIndices(int index)

Deprecated. google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1379

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];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
int

The breakRuleIndices at the given index.

getBreakRuleIndicesCount() (deprecated)

public int getBreakRuleIndicesCount()

Deprecated. google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1379

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];

Returns
TypeDescription
int

The count of breakRuleIndices.

getBreakRuleIndicesList() (deprecated)

public List<Integer> getBreakRuleIndicesList()

Deprecated. google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1379

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];

Returns
TypeDescription
List<Integer>

A list containing the breakRuleIndices.

getBreakRuleOrBuilder()

public 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;

Returns
TypeDescription
BreakRuleOrBuilder

getCapacities(int index)

public CapacityQuantity getCapacities(int index)

Deprecated: Use [Vehicle.load_limits][] instead.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantity

getCapacitiesBuilder(int index)

public CapacityQuantity.Builder getCapacitiesBuilder(int index)

Deprecated: Use [Vehicle.load_limits][] instead.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantity.Builder

getCapacitiesBuilderList()

public List<CapacityQuantity.Builder> getCapacitiesBuilderList()

Deprecated: Use [Vehicle.load_limits][] instead.

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

Returns
TypeDescription
List<Builder>

getCapacitiesCount()

public int getCapacitiesCount()

Deprecated: Use [Vehicle.load_limits][] instead.

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

Returns
TypeDescription
int

getCapacitiesList()

public List<CapacityQuantity> getCapacitiesList()

Deprecated: Use [Vehicle.load_limits][] instead.

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

Returns
TypeDescription
List<CapacityQuantity>

getCapacitiesOrBuilder(int index)

public CapacityQuantityOrBuilder getCapacitiesOrBuilder(int index)

Deprecated: Use [Vehicle.load_limits][] instead.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantityOrBuilder

getCapacitiesOrBuilderList()

public List<? extends CapacityQuantityOrBuilder> getCapacitiesOrBuilderList()

Deprecated: Use [Vehicle.load_limits][] instead.

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

Returns
TypeDescription
List<? extends com.google.cloud.optimization.v1.CapacityQuantityOrBuilder>

getCostPerHour()

public double getCostPerHour()

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;

Returns
TypeDescription
double

The costPerHour.

getCostPerKilometer()

public double getCostPerKilometer()

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;

Returns
TypeDescription
double

The costPerKilometer.

getCostPerTraveledHour()

public 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), and excludes waiting time and visit time.

double cost_per_traveled_hour = 17;

Returns
TypeDescription
double

The costPerTraveledHour.

getDefaultInstanceForType()

public Vehicle getDefaultInstanceForType()
Returns
TypeDescription
Vehicle

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEndLoadIntervals(int index)

public CapacityQuantityInterval getEndLoadIntervals(int index)

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantityInterval

getEndLoadIntervalsBuilder(int index)

public CapacityQuantityInterval.Builder getEndLoadIntervalsBuilder(int index)

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantityInterval.Builder

getEndLoadIntervalsBuilderList()

public List<CapacityQuantityInterval.Builder> getEndLoadIntervalsBuilderList()

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Returns
TypeDescription
List<Builder>

getEndLoadIntervalsCount()

public int getEndLoadIntervalsCount()

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Returns
TypeDescription
int

getEndLoadIntervalsList()

public List<CapacityQuantityInterval> getEndLoadIntervalsList()

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Returns
TypeDescription
List<CapacityQuantityInterval>

getEndLoadIntervalsOrBuilder(int index)

public CapacityQuantityIntervalOrBuilder getEndLoadIntervalsOrBuilder(int index)

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantityIntervalOrBuilder

getEndLoadIntervalsOrBuilderList()

public List<? extends CapacityQuantityIntervalOrBuilder> getEndLoadIntervalsOrBuilderList()

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Returns
TypeDescription
List<? extends com.google.cloud.optimization.v1.CapacityQuantityIntervalOrBuilder>

getEndLocation()

public 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
TypeDescription
com.google.type.LatLng

The endLocation.

getEndLocationBuilder()

public LatLng.Builder getEndLocationBuilder()

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
TypeDescription
com.google.type.LatLng.Builder

getEndLocationOrBuilder()

public 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;

Returns
TypeDescription
com.google.type.LatLngOrBuilder

getEndTags(int index)

public 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;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The endTags at the given index.

getEndTagsBytes(int index)

public 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;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the endTags at the given index.

getEndTagsCount()

public 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
TypeDescription
int

The count of endTags.

getEndTagsList()

public ProtocolStringList 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
TypeDescription
ProtocolStringList

A list containing the endTags.

getEndTimeWindows(int index)

public 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_* 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;

Parameter
NameDescription
indexint
Returns
TypeDescription
TimeWindow

getEndTimeWindowsBuilder(int index)

public TimeWindow.Builder getEndTimeWindowsBuilder(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_* 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;

Parameter
NameDescription
indexint
Returns
TypeDescription
TimeWindow.Builder

getEndTimeWindowsBuilderList()

public List<TimeWindow.Builder> getEndTimeWindowsBuilderList()

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;

Returns
TypeDescription
List<Builder>

getEndTimeWindowsCount()

public 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_* 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;

Returns
TypeDescription
int

getEndTimeWindowsList()

public 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_* 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;

Returns
TypeDescription
List<TimeWindow>

getEndTimeWindowsOrBuilder(int index)

public 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_* 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;

Parameter
NameDescription
indexint
Returns
TypeDescription
TimeWindowOrBuilder

getEndTimeWindowsOrBuilderList()

public 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_* 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;

Returns
TypeDescription
List<? extends com.google.cloud.optimization.v1.TimeWindowOrBuilder>

getEndWaypoint()

public 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
TypeDescription
Waypoint

The endWaypoint.

getEndWaypointBuilder()

public Waypoint.Builder getEndWaypointBuilder()

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
TypeDescription
Waypoint.Builder

getEndWaypointOrBuilder()

public 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;

Returns
TypeDescription
WaypointOrBuilder

getExtraVisitDurationForVisitType()

public Map<String,Duration> getExtraVisitDurationForVisitType()
Returns
TypeDescription
Map<String,Duration>

getExtraVisitDurationForVisitTypeCount()

public int getExtraVisitDurationForVisitTypeCount()

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;

Returns
TypeDescription
int

getExtraVisitDurationForVisitTypeMap()

public Map<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;

Returns
TypeDescription
Map<String,Duration>

getExtraVisitDurationForVisitTypeOrDefault(String key, Duration defaultValue)

public Duration getExtraVisitDurationForVisitTypeOrDefault(String key, Duration defaultValue)

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;

Parameters
NameDescription
keyString
defaultValueDuration
Returns
TypeDescription
Duration

getExtraVisitDurationForVisitTypeOrThrow(String key)

public Duration getExtraVisitDurationForVisitTypeOrThrow(String key)

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
Duration

getFixedCost()

public double getFixedCost()

Fixed cost applied if this vehicle is used to handle a shipment.

double fixed_cost = 19;

Returns
TypeDescription
double

The fixedCost.

getIgnore()

public 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
TypeDescription
boolean

The ignore.

getLabel()

public String getLabel()

Specifies a label for this vehicle. This label is reported in the response as the vehicle_label of the corresponding ShipmentRoute.

string label = 27;

Returns
TypeDescription
String

The label.

getLabelBytes()

public ByteString getLabelBytes()

Specifies a label for this vehicle. This label is reported in the response as the vehicle_label of the corresponding ShipmentRoute.

string label = 27;

Returns
TypeDescription
ByteString

The bytes for label.

getLoadLimits()

public Map<String,Vehicle.LoadLimit> getLoadLimits()

Use #getLoadLimitsMap() instead.

Returns
TypeDescription
Map<String,LoadLimit>

getLoadLimitsCount()

public 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 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;

Returns
TypeDescription
int

getLoadLimitsMap()

public 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 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;

Returns
TypeDescription
Map<String,LoadLimit>

getLoadLimitsOrDefault(String key, Vehicle.LoadLimit defaultValue)

public 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 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;

Parameters
NameDescription
keyString
defaultValueVehicle.LoadLimit
Returns
TypeDescription
Vehicle.LoadLimit

getLoadLimitsOrThrow(String key)

public 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 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;

Parameter
NameDescription
keyString
Returns
TypeDescription
Vehicle.LoadLimit

getMutableExtraVisitDurationForVisitType()

public Map<String,Duration> getMutableExtraVisitDurationForVisitType()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,Duration>

getMutableLoadLimits()

public Map<String,Vehicle.LoadLimit> getMutableLoadLimits()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,LoadLimit>

getRouteDistanceLimit()

public 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.DistanceLimit route_distance_limit = 23;

Returns
TypeDescription
DistanceLimit

The routeDistanceLimit.

getRouteDistanceLimitBuilder()

public DistanceLimit.Builder getRouteDistanceLimitBuilder()

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;

Returns
TypeDescription
DistanceLimit.Builder

getRouteDistanceLimitOrBuilder()

public 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.DistanceLimit route_distance_limit = 23;

Returns
TypeDescription
DistanceLimitOrBuilder

getRouteDurationLimit()

public 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
TypeDescription
Vehicle.DurationLimit

The routeDurationLimit.

getRouteDurationLimitBuilder()

public Vehicle.DurationLimit.Builder getRouteDurationLimitBuilder()

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
TypeDescription
Vehicle.DurationLimit.Builder

getRouteDurationLimitOrBuilder()

public 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;

Returns
TypeDescription
Vehicle.DurationLimitOrBuilder

getStartLoadIntervals(int index)

public CapacityQuantityInterval getStartLoadIntervals(int index)

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantityInterval

getStartLoadIntervalsBuilder(int index)

public CapacityQuantityInterval.Builder getStartLoadIntervalsBuilder(int index)

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantityInterval.Builder

getStartLoadIntervalsBuilderList()

public List<CapacityQuantityInterval.Builder> getStartLoadIntervalsBuilderList()

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Returns
TypeDescription
List<Builder>

getStartLoadIntervalsCount()

public int getStartLoadIntervalsCount()

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Returns
TypeDescription
int

getStartLoadIntervalsList()

public List<CapacityQuantityInterval> getStartLoadIntervalsList()

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Returns
TypeDescription
List<CapacityQuantityInterval>

getStartLoadIntervalsOrBuilder(int index)

public CapacityQuantityIntervalOrBuilder getStartLoadIntervalsOrBuilder(int index)

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
CapacityQuantityIntervalOrBuilder

getStartLoadIntervalsOrBuilderList()

public List<? extends CapacityQuantityIntervalOrBuilder> getStartLoadIntervalsOrBuilderList()

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Returns
TypeDescription
List<? extends com.google.cloud.optimization.v1.CapacityQuantityIntervalOrBuilder>

getStartLocation()

public 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
TypeDescription
com.google.type.LatLng

The startLocation.

getStartLocationBuilder()

public LatLng.Builder getStartLocationBuilder()

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
TypeDescription
com.google.type.LatLng.Builder

getStartLocationOrBuilder()

public 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;

Returns
TypeDescription
com.google.type.LatLngOrBuilder

getStartTags(int index)

public 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;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The startTags at the given index.

getStartTagsBytes(int index)

public 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;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the startTags at the given index.

getStartTagsCount()

public 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
TypeDescription
int

The count of startTags.

getStartTagsList()

public ProtocolStringList 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
TypeDescription
ProtocolStringList

A list containing the startTags.

getStartTimeWindows(int index)

public 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_* 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;

Parameter
NameDescription
indexint
Returns
TypeDescription
TimeWindow

getStartTimeWindowsBuilder(int index)

public TimeWindow.Builder getStartTimeWindowsBuilder(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
TimeWindow.Builder

getStartTimeWindowsBuilderList()

public List<TimeWindow.Builder> getStartTimeWindowsBuilderList()

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;

Returns
TypeDescription
List<Builder>

getStartTimeWindowsCount()

public int getStartTimeWindowsCount()

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;

Returns
TypeDescription
int

getStartTimeWindowsList()

public 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_* 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;

Returns
TypeDescription
List<TimeWindow>

getStartTimeWindowsOrBuilder(int index)

public 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_* 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;

Parameter
NameDescription
indexint
Returns
TypeDescription
TimeWindowOrBuilder

getStartTimeWindowsOrBuilderList()

public 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_* 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;

Returns
TypeDescription
List<? extends com.google.cloud.optimization.v1.TimeWindowOrBuilder>

getStartWaypoint()

public 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
TypeDescription
Waypoint

The startWaypoint.

getStartWaypointBuilder()

public Waypoint.Builder getStartWaypointBuilder()

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
TypeDescription
Waypoint.Builder

getStartWaypointOrBuilder()

public 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;

Returns
TypeDescription
WaypointOrBuilder

getTravelDurationLimit()

public 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.Vehicle.DurationLimit travel_duration_limit = 22;

Returns
TypeDescription
Vehicle.DurationLimit

The travelDurationLimit.

getTravelDurationLimitBuilder()

public Vehicle.DurationLimit.Builder getTravelDurationLimitBuilder()

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;

Returns
TypeDescription
Vehicle.DurationLimit.Builder

getTravelDurationLimitOrBuilder()

public 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.Vehicle.DurationLimit travel_duration_limit = 22;

Returns
TypeDescription
Vehicle.DurationLimitOrBuilder

getTravelDurationMultiple()

public 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
TypeDescription
double

The travelDurationMultiple.

getTravelMode()

public 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
TypeDescription
Vehicle.TravelMode

The travelMode.

getTravelModeValue()

public 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
TypeDescription
int

The enum numeric value on the wire for travelMode.

getUnloadingPolicy()

public Vehicle.UnloadingPolicy getUnloadingPolicy()

Unloading policy enforced on the vehicle.

.google.cloud.optimization.v1.Vehicle.UnloadingPolicy unloading_policy = 12;

Returns
TypeDescription
Vehicle.UnloadingPolicy

The unloadingPolicy.

getUnloadingPolicyValue()

public int getUnloadingPolicyValue()

Unloading policy enforced on the vehicle.

.google.cloud.optimization.v1.Vehicle.UnloadingPolicy unloading_policy = 12;

Returns
TypeDescription
int

The enum numeric value on the wire for unloadingPolicy.

getUsedIfRouteIsEmpty()

public 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
TypeDescription
boolean

The usedIfRouteIsEmpty.

hasBreakRule()

public 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
TypeDescription
boolean

Whether the breakRule field is set.

hasEndLocation()

public 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
TypeDescription
boolean

Whether the endLocation field is set.

hasEndWaypoint()

public 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
TypeDescription
boolean

Whether the endWaypoint field is set.

hasRouteDistanceLimit()

public 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.DistanceLimit route_distance_limit = 23;

Returns
TypeDescription
boolean

Whether the routeDistanceLimit field is set.

hasRouteDurationLimit()

public 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
TypeDescription
boolean

Whether the routeDurationLimit field is set.

hasStartLocation()

public 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
TypeDescription
boolean

Whether the startLocation field is set.

hasStartWaypoint()

public 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
TypeDescription
boolean

Whether the startWaypoint field is set.

hasTravelDurationLimit()

public 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.Vehicle.DurationLimit travel_duration_limit = 22;

Returns
TypeDescription
boolean

Whether the travelDurationLimit field is set.

hasTravelDurationMultiple()

public 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
TypeDescription
boolean

Whether the travelDurationMultiple field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBreakRule(BreakRule value)

public Vehicle.Builder mergeBreakRule(BreakRule value)

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;

Parameter
NameDescription
valueBreakRule
Returns
TypeDescription
Vehicle.Builder

mergeEndLocation(LatLng value)

public Vehicle.Builder mergeEndLocation(LatLng value)

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;

Parameter
NameDescription
valuecom.google.type.LatLng
Returns
TypeDescription
Vehicle.Builder

mergeEndWaypoint(Waypoint value)

public Vehicle.Builder mergeEndWaypoint(Waypoint value)

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;

Parameter
NameDescription
valueWaypoint
Returns
TypeDescription
Vehicle.Builder

mergeFrom(Vehicle other)

public Vehicle.Builder mergeFrom(Vehicle other)
Parameter
NameDescription
otherVehicle
Returns
TypeDescription
Vehicle.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Vehicle.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Vehicle.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Vehicle.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Vehicle.Builder
Overrides

mergeRouteDistanceLimit(DistanceLimit value)

public Vehicle.Builder mergeRouteDistanceLimit(DistanceLimit value)

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;

Parameter
NameDescription
valueDistanceLimit
Returns
TypeDescription
Vehicle.Builder

mergeRouteDurationLimit(Vehicle.DurationLimit value)

public Vehicle.Builder mergeRouteDurationLimit(Vehicle.DurationLimit value)

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;

Parameter
NameDescription
valueVehicle.DurationLimit
Returns
TypeDescription
Vehicle.Builder

mergeStartLocation(LatLng value)

public Vehicle.Builder mergeStartLocation(LatLng value)

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;

Parameter
NameDescription
valuecom.google.type.LatLng
Returns
TypeDescription
Vehicle.Builder

mergeStartWaypoint(Waypoint value)

public Vehicle.Builder mergeStartWaypoint(Waypoint value)

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;

Parameter
NameDescription
valueWaypoint
Returns
TypeDescription
Vehicle.Builder

mergeTravelDurationLimit(Vehicle.DurationLimit value)

public Vehicle.Builder mergeTravelDurationLimit(Vehicle.DurationLimit value)

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;

Parameter
NameDescription
valueVehicle.DurationLimit
Returns
TypeDescription
Vehicle.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Vehicle.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Vehicle.Builder
Overrides

putAllExtraVisitDurationForVisitType(Map<String,Duration> values)

public Vehicle.Builder putAllExtraVisitDurationForVisitType(Map<String,Duration> values)

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;

Parameter
NameDescription
valuesMap<String,Duration>
Returns
TypeDescription
Vehicle.Builder

putAllLoadLimits(Map<String,Vehicle.LoadLimit> values)

public Vehicle.Builder putAllLoadLimits(Map<String,Vehicle.LoadLimit> values)

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;

Parameter
NameDescription
valuesMap<String,LoadLimit>
Returns
TypeDescription
Vehicle.Builder

putExtraVisitDurationForVisitType(String key, Duration value)

public Vehicle.Builder putExtraVisitDurationForVisitType(String key, Duration value)

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;

Parameters
NameDescription
keyString
valueDuration
Returns
TypeDescription
Vehicle.Builder

putLoadLimits(String key, Vehicle.LoadLimit value)

public Vehicle.Builder putLoadLimits(String key, Vehicle.LoadLimit value)

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;

Parameters
NameDescription
keyString
valueVehicle.LoadLimit
Returns
TypeDescription
Vehicle.Builder

removeCapacities(int index)

public Vehicle.Builder removeCapacities(int index)

Deprecated: Use [Vehicle.load_limits][] instead.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Vehicle.Builder

removeEndLoadIntervals(int index)

public Vehicle.Builder removeEndLoadIntervals(int index)

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
Vehicle.Builder

removeEndTimeWindows(int index)

public Vehicle.Builder removeEndTimeWindows(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_* 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;

Parameter
NameDescription
indexint
Returns
TypeDescription
Vehicle.Builder

removeExtraVisitDurationForVisitType(String key)

public Vehicle.Builder removeExtraVisitDurationForVisitType(String key)

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
Vehicle.Builder

removeLoadLimits(String key)

public Vehicle.Builder removeLoadLimits(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 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;

Parameter
NameDescription
keyString
Returns
TypeDescription
Vehicle.Builder

removeStartLoadIntervals(int index)

public Vehicle.Builder removeStartLoadIntervals(int index)

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Parameter
NameDescription
indexint
Returns
TypeDescription
Vehicle.Builder

removeStartTimeWindows(int index)

public Vehicle.Builder removeStartTimeWindows(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
Vehicle.Builder

setBreakRule(BreakRule value)

public Vehicle.Builder setBreakRule(BreakRule value)

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;

Parameter
NameDescription
valueBreakRule
Returns
TypeDescription
Vehicle.Builder

setBreakRule(BreakRule.Builder builderForValue)

public Vehicle.Builder setBreakRule(BreakRule.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBreakRule.Builder
Returns
TypeDescription
Vehicle.Builder

setBreakRuleIndices(int index, int value) (deprecated)

public Vehicle.Builder setBreakRuleIndices(int index, int value)

Deprecated. google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1379

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];

Parameters
NameDescription
indexint

The index to set the value at.

valueint

The breakRuleIndices to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

setCapacities(int index, CapacityQuantity value)

public Vehicle.Builder setCapacities(int index, CapacityQuantity value)

Deprecated: Use [Vehicle.load_limits][] instead.

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

Parameters
NameDescription
indexint
valueCapacityQuantity
Returns
TypeDescription
Vehicle.Builder

setCapacities(int index, CapacityQuantity.Builder builderForValue)

public Vehicle.Builder setCapacities(int index, CapacityQuantity.Builder builderForValue)

Deprecated: Use [Vehicle.load_limits][] instead.

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

Parameters
NameDescription
indexint
builderForValueCapacityQuantity.Builder
Returns
TypeDescription
Vehicle.Builder

setCostPerHour(double value)

public Vehicle.Builder setCostPerHour(double value)

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;

Parameter
NameDescription
valuedouble

The costPerHour to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

setCostPerKilometer(double value)

public Vehicle.Builder setCostPerKilometer(double value)

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;

Parameter
NameDescription
valuedouble

The costPerKilometer to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

setCostPerTraveledHour(double value)

public Vehicle.Builder setCostPerTraveledHour(double value)

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;

Parameter
NameDescription
valuedouble

The costPerTraveledHour to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

setEndLoadIntervals(int index, CapacityQuantityInterval value)

public Vehicle.Builder setEndLoadIntervals(int index, CapacityQuantityInterval value)

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Parameters
NameDescription
indexint
valueCapacityQuantityInterval
Returns
TypeDescription
Vehicle.Builder

setEndLoadIntervals(int index, CapacityQuantityInterval.Builder builderForValue)

public Vehicle.Builder setEndLoadIntervals(int index, CapacityQuantityInterval.Builder builderForValue)

Deprecated: Use [Vehicle.LoadLimit.end_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];

Parameters
NameDescription
indexint
builderForValueCapacityQuantityInterval.Builder
Returns
TypeDescription
Vehicle.Builder

setEndLocation(LatLng value)

public Vehicle.Builder setEndLocation(LatLng value)

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;

Parameter
NameDescription
valuecom.google.type.LatLng
Returns
TypeDescription
Vehicle.Builder

setEndLocation(LatLng.Builder builderForValue)

public Vehicle.Builder setEndLocation(LatLng.Builder builderForValue)

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;

Parameter
NameDescription
builderForValuecom.google.type.LatLng.Builder
Returns
TypeDescription
Vehicle.Builder

setEndTags(int index, String value)

public Vehicle.Builder setEndTags(int index, String value)

Specifies tags attached to the end of the vehicle's route. Empty or duplicate strings are not allowed.

repeated string end_tags = 8;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The endTags to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

setEndTimeWindows(int index, TimeWindow value)

public Vehicle.Builder setEndTimeWindows(int index, TimeWindow value)

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;

Parameters
NameDescription
indexint
valueTimeWindow
Returns
TypeDescription
Vehicle.Builder

setEndTimeWindows(int index, TimeWindow.Builder builderForValue)

public Vehicle.Builder setEndTimeWindows(int index, TimeWindow.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueTimeWindow.Builder
Returns
TypeDescription
Vehicle.Builder

setEndWaypoint(Waypoint value)

public Vehicle.Builder setEndWaypoint(Waypoint value)

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;

Parameter
NameDescription
valueWaypoint
Returns
TypeDescription
Vehicle.Builder

setEndWaypoint(Waypoint.Builder builderForValue)

public Vehicle.Builder setEndWaypoint(Waypoint.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueWaypoint.Builder
Returns
TypeDescription
Vehicle.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Vehicle.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Vehicle.Builder
Overrides

setFixedCost(double value)

public Vehicle.Builder setFixedCost(double value)

Fixed cost applied if this vehicle is used to handle a shipment.

double fixed_cost = 19;

Parameter
NameDescription
valuedouble

The fixedCost to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

setIgnore(boolean value)

public Vehicle.Builder setIgnore(boolean value)

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;

Parameter
NameDescription
valueboolean

The ignore to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

setLabel(String value)

public Vehicle.Builder setLabel(String value)

Specifies a label for this vehicle. This label is reported in the response as the vehicle_label of the corresponding ShipmentRoute.

string label = 27;

Parameter
NameDescription
valueString

The label to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

setLabelBytes(ByteString value)

public Vehicle.Builder setLabelBytes(ByteString value)

Specifies a label for this vehicle. This label is reported in the response as the vehicle_label of the corresponding ShipmentRoute.

string label = 27;

Parameter
NameDescription
valueByteString

The bytes for label to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

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

public Vehicle.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Vehicle.Builder
Overrides

setRouteDistanceLimit(DistanceLimit value)

public Vehicle.Builder setRouteDistanceLimit(DistanceLimit value)

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;

Parameter
NameDescription
valueDistanceLimit
Returns
TypeDescription
Vehicle.Builder

setRouteDistanceLimit(DistanceLimit.Builder builderForValue)

public Vehicle.Builder setRouteDistanceLimit(DistanceLimit.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueDistanceLimit.Builder
Returns
TypeDescription
Vehicle.Builder

setRouteDurationLimit(Vehicle.DurationLimit value)

public Vehicle.Builder setRouteDurationLimit(Vehicle.DurationLimit value)

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;

Parameter
NameDescription
valueVehicle.DurationLimit
Returns
TypeDescription
Vehicle.Builder

setRouteDurationLimit(Vehicle.DurationLimit.Builder builderForValue)

public Vehicle.Builder setRouteDurationLimit(Vehicle.DurationLimit.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueVehicle.DurationLimit.Builder
Returns
TypeDescription
Vehicle.Builder

setStartLoadIntervals(int index, CapacityQuantityInterval value)

public Vehicle.Builder setStartLoadIntervals(int index, CapacityQuantityInterval value)

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Parameters
NameDescription
indexint
valueCapacityQuantityInterval
Returns
TypeDescription
Vehicle.Builder

setStartLoadIntervals(int index, CapacityQuantityInterval.Builder builderForValue)

public Vehicle.Builder setStartLoadIntervals(int index, CapacityQuantityInterval.Builder builderForValue)

Deprecated: Use [Vehicle.LoadLimit.start_load_interval][] instead.

repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];

Parameters
NameDescription
indexint
builderForValueCapacityQuantityInterval.Builder
Returns
TypeDescription
Vehicle.Builder

setStartLocation(LatLng value)

public Vehicle.Builder setStartLocation(LatLng value)

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;

Parameter
NameDescription
valuecom.google.type.LatLng
Returns
TypeDescription
Vehicle.Builder

setStartLocation(LatLng.Builder builderForValue)

public Vehicle.Builder setStartLocation(LatLng.Builder builderForValue)

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;

Parameter
NameDescription
builderForValuecom.google.type.LatLng.Builder
Returns
TypeDescription
Vehicle.Builder

setStartTags(int index, String value)

public Vehicle.Builder setStartTags(int index, String value)

Specifies tags attached to the start of the vehicle's route. Empty or duplicate strings are not allowed.

repeated string start_tags = 7;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The startTags to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

setStartTimeWindows(int index, TimeWindow value)

public Vehicle.Builder setStartTimeWindows(int index, TimeWindow value)

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;

Parameters
NameDescription
indexint
valueTimeWindow
Returns
TypeDescription
Vehicle.Builder

setStartTimeWindows(int index, TimeWindow.Builder builderForValue)

public Vehicle.Builder setStartTimeWindows(int index, TimeWindow.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueTimeWindow.Builder
Returns
TypeDescription
Vehicle.Builder

setStartWaypoint(Waypoint value)

public Vehicle.Builder setStartWaypoint(Waypoint value)

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;

Parameter
NameDescription
valueWaypoint
Returns
TypeDescription
Vehicle.Builder

setStartWaypoint(Waypoint.Builder builderForValue)

public Vehicle.Builder setStartWaypoint(Waypoint.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueWaypoint.Builder
Returns
TypeDescription
Vehicle.Builder

setTravelDurationLimit(Vehicle.DurationLimit value)

public Vehicle.Builder setTravelDurationLimit(Vehicle.DurationLimit value)

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;

Parameter
NameDescription
valueVehicle.DurationLimit
Returns
TypeDescription
Vehicle.Builder

setTravelDurationLimit(Vehicle.DurationLimit.Builder builderForValue)

public Vehicle.Builder setTravelDurationLimit(Vehicle.DurationLimit.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueVehicle.DurationLimit.Builder
Returns
TypeDescription
Vehicle.Builder

setTravelDurationMultiple(double value)

public Vehicle.Builder setTravelDurationMultiple(double value)

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;

Parameter
NameDescription
valuedouble

The travelDurationMultiple to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

setTravelMode(Vehicle.TravelMode value)

public Vehicle.Builder setTravelMode(Vehicle.TravelMode value)

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;

Parameter
NameDescription
valueVehicle.TravelMode

The travelMode to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

setTravelModeValue(int value)

public Vehicle.Builder setTravelModeValue(int value)

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;

Parameter
NameDescription
valueint

The enum numeric value on the wire for travelMode to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Vehicle.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Vehicle.Builder
Overrides

setUnloadingPolicy(Vehicle.UnloadingPolicy value)

public Vehicle.Builder setUnloadingPolicy(Vehicle.UnloadingPolicy value)

Unloading policy enforced on the vehicle.

.google.cloud.optimization.v1.Vehicle.UnloadingPolicy unloading_policy = 12;

Parameter
NameDescription
valueVehicle.UnloadingPolicy

The unloadingPolicy to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

setUnloadingPolicyValue(int value)

public Vehicle.Builder setUnloadingPolicyValue(int value)

Unloading policy enforced on the vehicle.

.google.cloud.optimization.v1.Vehicle.UnloadingPolicy unloading_policy = 12;

Parameter
NameDescription
valueint

The enum numeric value on the wire for unloadingPolicy to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.

setUsedIfRouteIsEmpty(boolean value)

public Vehicle.Builder setUsedIfRouteIsEmpty(boolean value)

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;

Parameter
NameDescription
valueboolean

The usedIfRouteIsEmpty to set.

Returns
TypeDescription
Vehicle.Builder

This builder for chaining.