- 1.51.0 (latest)
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.14
- 0.1.2
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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Vehicle.BuilderImplements
VehicleOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
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=1484
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 | |
|---|---|
| Name | Description |
values | Iterable<? extends java.lang.Integer>The breakRuleIndices to add. |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | This builder for chaining. |
addAllCapacities(Iterable<? extends CapacityQuantity> values) (deprecated)
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 | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.optimization.v1.CapacityQuantity> |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addAllEndLoadIntervals(Iterable<? extends CapacityQuantityInterval> values) (deprecated)
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 | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.optimization.v1.CapacityQuantityInterval> |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
values | Iterable<String>The endTags to add. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.optimization.v1.TimeWindow> |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addAllStartLoadIntervals(Iterable<? extends CapacityQuantityInterval> values) (deprecated)
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 | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.optimization.v1.CapacityQuantityInterval> |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
values | Iterable<String>The startTags to add. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.cloud.optimization.v1.TimeWindow> |
| Returns | |
|---|---|
| Type | Description |
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=1484
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 | |
|---|---|
| Name | Description |
value | intThe breakRuleIndices to add. |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | This builder for chaining. |
addCapacities(CapacityQuantity value) (deprecated)
public Vehicle.Builder addCapacities(CapacityQuantity value)Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
value | CapacityQuantity |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addCapacities(CapacityQuantity.Builder builderForValue) (deprecated)
public Vehicle.Builder addCapacities(CapacityQuantity.Builder builderForValue)Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | CapacityQuantity.Builder |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addCapacities(int index, CapacityQuantity value) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
value | CapacityQuantity |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addCapacities(int index, CapacityQuantity.Builder builderForValue) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
builderForValue | CapacityQuantity.Builder |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addCapacitiesBuilder() (deprecated)
public CapacityQuantity.Builder addCapacitiesBuilder()Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
CapacityQuantity.Builder | |
addCapacitiesBuilder(int index) (deprecated)
public CapacityQuantity.Builder addCapacitiesBuilder(int index)Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantity.Builder | |
addEndLoadIntervals(CapacityQuantityInterval value) (deprecated)
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 | |
|---|---|
| Name | Description |
value | CapacityQuantityInterval |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addEndLoadIntervals(CapacityQuantityInterval.Builder builderForValue) (deprecated)
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 | |
|---|---|
| Name | Description |
builderForValue | CapacityQuantityInterval.Builder |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addEndLoadIntervals(int index, CapacityQuantityInterval value) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
value | CapacityQuantityInterval |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addEndLoadIntervals(int index, CapacityQuantityInterval.Builder builderForValue) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
builderForValue | CapacityQuantityInterval.Builder |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addEndLoadIntervalsBuilder() (deprecated)
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 | |
|---|---|
| Type | Description |
CapacityQuantityInterval.Builder | |
addEndLoadIntervalsBuilder(int index) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | StringThe endTags to add. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | ByteStringThe bytes of the endTags to add. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | TimeWindow |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | TimeWindow.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
value | TimeWindow |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
builderForValue | TimeWindow.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder | |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Vehicle.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addStartLoadIntervals(CapacityQuantityInterval value) (deprecated)
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 | |
|---|---|
| Name | Description |
value | CapacityQuantityInterval |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addStartLoadIntervals(CapacityQuantityInterval.Builder builderForValue) (deprecated)
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 | |
|---|---|
| Name | Description |
builderForValue | CapacityQuantityInterval.Builder |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addStartLoadIntervals(int index, CapacityQuantityInterval value) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
value | CapacityQuantityInterval |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addStartLoadIntervals(int index, CapacityQuantityInterval.Builder builderForValue) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
builderForValue | CapacityQuantityInterval.Builder |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
addStartLoadIntervalsBuilder() (deprecated)
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 | |
|---|---|
| Type | Description |
CapacityQuantityInterval.Builder | |
addStartLoadIntervalsBuilder(int index) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | StringThe startTags to add. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | ByteStringThe bytes of the startTags to add. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | TimeWindow |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | TimeWindow.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
value | TimeWindow |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
builderForValue | TimeWindow.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder | |
build()
public Vehicle build()| Returns | |
|---|---|
| Type | Description |
Vehicle | |
buildPartial()
public Vehicle buildPartial()| Returns | |
|---|---|
| Type | Description |
Vehicle | |
clear()
public Vehicle.Builder clear()| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
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 | |
|---|---|
| Type | Description |
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=1484
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 | |
|---|---|
| Type | Description |
Vehicle.Builder | This builder for chaining. |
clearCapacities() (deprecated)
public Vehicle.Builder clearCapacities()Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Vehicle.Builder | This builder for chaining. |
clearEndLoadIntervals() (deprecated)
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Vehicle.Builder | |
clearExtraVisitDurationForVisitType()
public Vehicle.Builder clearExtraVisitDurationForVisitType()| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
clearField(Descriptors.FieldDescriptor field)
public Vehicle.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
clearFixedCost()
public Vehicle.Builder clearFixedCost()Fixed cost applied if this vehicle is used to handle a shipment.
double fixed_cost = 19;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Vehicle.Builder | This builder for chaining. |
clearLoadLimits()
public Vehicle.Builder clearLoadLimits()| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public Vehicle.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Vehicle.Builder | |
clearRouteModifiers()
public Vehicle.Builder clearRouteModifiers()Optional. A set of conditions to satisfy that affect the way routes are calculated for the given vehicle.
.google.cloud.optimization.v1.RouteModifiers route_modifiers = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
clearStartLoadIntervals() (deprecated)
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Vehicle.Builder | This builder for chaining. |
clone()
public Vehicle.Builder clone()| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
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 | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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=1484
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 | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
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=1484
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 | |
|---|---|
| Type | Description |
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=1484
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
BreakRuleOrBuilder | |
getCapacities(int index) (deprecated)
public CapacityQuantity getCapacities(int index)Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantity | |
getCapacitiesBuilder(int index) (deprecated)
public CapacityQuantity.Builder getCapacitiesBuilder(int index)Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantity.Builder | |
getCapacitiesBuilderList() (deprecated)
public List<CapacityQuantity.Builder> getCapacitiesBuilderList()Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
getCapacitiesCount() (deprecated)
public int getCapacitiesCount()Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
int | |
getCapacitiesList() (deprecated)
public List<CapacityQuantity> getCapacitiesList()Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
List<CapacityQuantity> | |
getCapacitiesOrBuilder(int index) (deprecated)
public CapacityQuantityOrBuilder getCapacitiesOrBuilder(int index)Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantityOrBuilder | |
getCapacitiesOrBuilderList() (deprecated)
public List<? extends CapacityQuantityOrBuilder> getCapacitiesOrBuilderList()Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
double | The costPerTraveledHour. |
getDefaultInstanceForType()
public Vehicle getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Vehicle | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getEndLoadIntervals(int index) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantityInterval | |
getEndLoadIntervalsBuilder(int index) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantityInterval.Builder | |
getEndLoadIntervalsBuilderList() (deprecated)
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 | |
|---|---|
| Type | Description |
List<Builder> | |
getEndLoadIntervalsCount() (deprecated)
public int getEndLoadIntervalsCount()Deprecated: Use Vehicle.LoadLimit.end_load_interval instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
int | |
getEndLoadIntervalsList() (deprecated)
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 | |
|---|---|
| Type | Description |
List<CapacityQuantityInterval> | |
getEndLoadIntervalsOrBuilder(int index) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantityIntervalOrBuilder | |
getEndLoadIntervalsOrBuilderList() (deprecated)
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
WaypointOrBuilder | |
getExtraVisitDurationForVisitType() (deprecated)
public Map<String,Duration> getExtraVisitDurationForVisitType()Use #getExtraVisitDurationForVisitTypeMap() instead.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key | String |
defaultValue | Duration |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Duration | |
getFixedCost()
public double getFixedCost()Fixed cost applied if this vehicle is used to handle a shipment.
double fixed_cost = 19;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString | The bytes for label. |
getLoadLimits() (deprecated)
public Map<String,Vehicle.LoadLimit> getLoadLimits()Use #getLoadLimitsMap() instead.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key | String |
defaultValue | Vehicle.LoadLimit |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Vehicle.LoadLimit | |
getMutableExtraVisitDurationForVisitType() (deprecated)
public Map<String,Duration> getMutableExtraVisitDurationForVisitType()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Duration> | |
getMutableLoadLimits() (deprecated)
public Map<String,Vehicle.LoadLimit> getMutableLoadLimits()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Vehicle.DurationLimitOrBuilder | |
getRouteModifiers()
public RouteModifiers getRouteModifiers()Optional. A set of conditions to satisfy that affect the way routes are calculated for the given vehicle.
.google.cloud.optimization.v1.RouteModifiers route_modifiers = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RouteModifiers | The routeModifiers. |
getRouteModifiersBuilder()
public RouteModifiers.Builder getRouteModifiersBuilder()Optional. A set of conditions to satisfy that affect the way routes are calculated for the given vehicle.
.google.cloud.optimization.v1.RouteModifiers route_modifiers = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RouteModifiers.Builder | |
getRouteModifiersOrBuilder()
public RouteModifiersOrBuilder getRouteModifiersOrBuilder()Optional. A set of conditions to satisfy that affect the way routes are calculated for the given vehicle.
.google.cloud.optimization.v1.RouteModifiers route_modifiers = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RouteModifiersOrBuilder | |
getStartLoadIntervals(int index) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantityInterval | |
getStartLoadIntervalsBuilder(int index) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantityInterval.Builder | |
getStartLoadIntervalsBuilderList() (deprecated)
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 | |
|---|---|
| Type | Description |
List<Builder> | |
getStartLoadIntervalsCount() (deprecated)
public int getStartLoadIntervalsCount()Deprecated: Use Vehicle.LoadLimit.start_load_interval instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
int | |
getStartLoadIntervalsList() (deprecated)
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 | |
|---|---|
| Type | Description |
List<CapacityQuantityInterval> | |
getStartLoadIntervalsOrBuilder(int index) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantityIntervalOrBuilder | |
getStartLoadIntervalsOrBuilderList() (deprecated)
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Vehicle.UnloadingPolicy | The unloadingPolicy. |
getUnloadingPolicyValue()
public int getUnloadingPolicyValue()Unloading policy enforced on the vehicle.
.google.cloud.optimization.v1.Vehicle.UnloadingPolicy unloading_policy = 12;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean | Whether the routeDurationLimit field is set. |
hasRouteModifiers()
public boolean hasRouteModifiers()Optional. A set of conditions to satisfy that affect the way routes are calculated for the given vehicle.
.google.cloud.optimization.v1.RouteModifiers route_modifiers = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the routeModifiers 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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean | Whether the travelDurationMultiple field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
|---|---|
| Name | Description |
value | BreakRule |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | com.google.type.LatLng |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | Waypoint |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
mergeFrom(Vehicle other)
public Vehicle.Builder mergeFrom(Vehicle other)| Parameter | |
|---|---|
| Name | Description |
other | Vehicle |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Vehicle.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Vehicle.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
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 | |
|---|---|
| Name | Description |
value | DistanceLimit |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | Vehicle.DurationLimit |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
mergeRouteModifiers(RouteModifiers value)
public Vehicle.Builder mergeRouteModifiers(RouteModifiers value)Optional. A set of conditions to satisfy that affect the way routes are calculated for the given vehicle.
.google.cloud.optimization.v1.RouteModifiers route_modifiers = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | RouteModifiers |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | com.google.type.LatLng |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | Waypoint |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | Vehicle.DurationLimit |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Vehicle.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
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 | |
|---|---|
| Name | Description |
values | Map<String,Duration> |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
values | Map<String,LoadLimit> |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key | String |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key | String |
value | Vehicle.LoadLimit |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
removeCapacities(int index) (deprecated)
public Vehicle.Builder removeCapacities(int index)Deprecated: Use Vehicle.load_limits instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
removeEndLoadIntervals(int index) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
removeStartLoadIntervals(int index) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | BreakRule |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | BreakRule.Builder |
| Returns | |
|---|---|
| Type | Description |
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=1484
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 | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | intThe breakRuleIndices to set. |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | This builder for chaining. |
setCapacities(int index, CapacityQuantity value) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
value | CapacityQuantity |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
setCapacities(int index, CapacityQuantity.Builder builderForValue) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
builderForValue | CapacityQuantity.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | doubleThe costPerHour to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | doubleThe costPerKilometer to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | doubleThe costPerTraveledHour to set. |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | This builder for chaining. |
setEndLoadIntervals(int index, CapacityQuantityInterval value) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
value | CapacityQuantityInterval |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
setEndLoadIntervals(int index, CapacityQuantityInterval.Builder builderForValue) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
builderForValue | CapacityQuantityInterval.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | com.google.type.LatLng |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | com.google.type.LatLng.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe endTags to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
value | TimeWindow |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
builderForValue | TimeWindow.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | Waypoint |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | Waypoint.Builder |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public Vehicle.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
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 | |
|---|---|
| Name | Description |
value | doubleThe fixedCost to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | booleanThe ignore to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | StringThe label to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for label to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
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 | |
|---|---|
| Name | Description |
value | DistanceLimit |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | DistanceLimit.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | Vehicle.DurationLimit |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | Vehicle.DurationLimit.Builder |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
setRouteModifiers(RouteModifiers value)
public Vehicle.Builder setRouteModifiers(RouteModifiers value)Optional. A set of conditions to satisfy that affect the way routes are calculated for the given vehicle.
.google.cloud.optimization.v1.RouteModifiers route_modifiers = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | RouteModifiers |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
setRouteModifiers(RouteModifiers.Builder builderForValue)
public Vehicle.Builder setRouteModifiers(RouteModifiers.Builder builderForValue)Optional. A set of conditions to satisfy that affect the way routes are calculated for the given vehicle.
.google.cloud.optimization.v1.RouteModifiers route_modifiers = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | RouteModifiers.Builder |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
setStartLoadIntervals(int index, CapacityQuantityInterval value) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
value | CapacityQuantityInterval |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
setStartLoadIntervals(int index, CapacityQuantityInterval.Builder builderForValue) (deprecated)
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 | |
|---|---|
| Name | Description |
index | int |
builderForValue | CapacityQuantityInterval.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | com.google.type.LatLng |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | com.google.type.LatLng.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe startTags to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
value | TimeWindow |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
builderForValue | TimeWindow.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | Waypoint |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | Waypoint.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | Vehicle.DurationLimit |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue | Vehicle.DurationLimit.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | doubleThe travelDurationMultiple to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | Vehicle.TravelModeThe travelMode to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for travelMode to set. |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Vehicle.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | |
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 | |
|---|---|
| Name | Description |
value | Vehicle.UnloadingPolicyThe unloadingPolicy to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for unloadingPolicy to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | booleanThe usedIfRouteIsEmpty to set. |
| Returns | |
|---|---|
| Type | Description |
Vehicle.Builder | This builder for chaining. |