Package com.google.cloud.optimization.v1
Class Vehicle
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.optimization.v1.Vehicle
-
- All Implemented Interfaces:
VehicleOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
public final class Vehicle extends com.google.protobuf.GeneratedMessageV3 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 typegoogle.cloud.optimization.v1.Vehicle- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVehicle.BuilderModels a vehicle in a shipment problem.static classVehicle.DurationLimitA limit defining a maximum duration of the route of a vehicle.static interfaceVehicle.DurationLimitOrBuilderstatic classVehicle.LoadLimitDefines a load limit applying to a vehicle, e.g.static interfaceVehicle.LoadLimitOrBuilderstatic classVehicle.TravelModeTravel modes which can be used by vehicles.static classVehicle.UnloadingPolicyPolicy on how a vehicle can be unloaded.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleancontainsExtraVisitDurationForVisitType(String key)Specifies a map from visit_types strings to durations.booleancontainsLoadLimits(String key)Capacities of the vehicle (weight, volume, # of pallets for example).booleanequals(Object obj)BreakRulegetBreakRule()Describes the break schedule to be enforced on this vehicle.intgetBreakRuleIndices(int index)Deprecated.google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated.intgetBreakRuleIndicesCount()Deprecated.google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated.List<Integer>getBreakRuleIndicesList()Deprecated.google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated.BreakRuleOrBuildergetBreakRuleOrBuilder()Describes the break schedule to be enforced on this vehicle.CapacityQuantitygetCapacities(int index)Deprecated.intgetCapacitiesCount()Deprecated.List<CapacityQuantity>getCapacitiesList()Deprecated.CapacityQuantityOrBuildergetCapacitiesOrBuilder(int index)Deprecated.List<? extends CapacityQuantityOrBuilder>getCapacitiesOrBuilderList()Deprecated.doublegetCostPerHour()Vehicle costs: all costs add up and must be in the same unit as [Shipment.penalty_cost][google.cloud.optimization.v1.Shipment.penalty_cost].doublegetCostPerKilometer()Cost per kilometer of the vehicle route.doublegetCostPerTraveledHour()Cost per traveled hour of the vehicle route.static VehiclegetDefaultInstance()VehiclegetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()CapacityQuantityIntervalgetEndLoadIntervals(int index)Deprecated.intgetEndLoadIntervalsCount()Deprecated.List<CapacityQuantityInterval>getEndLoadIntervalsList()Deprecated.CapacityQuantityIntervalOrBuildergetEndLoadIntervalsOrBuilder(int index)Deprecated.List<? extends CapacityQuantityIntervalOrBuilder>getEndLoadIntervalsOrBuilderList()Deprecated.com.google.type.LatLnggetEndLocation()Geographic location where the vehicle ends after it has completed its last `VisitRequest`.com.google.type.LatLngOrBuildergetEndLocationOrBuilder()Geographic location where the vehicle ends after it has completed its last `VisitRequest`.StringgetEndTags(int index)Specifies tags attached to the end of the vehicle's route.com.google.protobuf.ByteStringgetEndTagsBytes(int index)Specifies tags attached to the end of the vehicle's route.intgetEndTagsCount()Specifies tags attached to the end of the vehicle's route.com.google.protobuf.ProtocolStringListgetEndTagsList()Specifies tags attached to the end of the vehicle's route.TimeWindowgetEndTimeWindows(int index)Time windows during which the vehicle may arrive at its end location.intgetEndTimeWindowsCount()Time windows during which the vehicle may arrive at its end location.List<TimeWindow>getEndTimeWindowsList()Time windows during which the vehicle may arrive at its end location.TimeWindowOrBuildergetEndTimeWindowsOrBuilder(int index)Time windows during which the vehicle may arrive at its end location.List<? extends TimeWindowOrBuilder>getEndTimeWindowsOrBuilderList()Time windows during which the vehicle may arrive at its end location.WaypointgetEndWaypoint()Waypoint representing a geographic location where the vehicle ends after it has completed its last `VisitRequest`.WaypointOrBuildergetEndWaypointOrBuilder()Waypoint representing a geographic location where the vehicle ends after it has completed its last `VisitRequest`.Map<String,com.google.protobuf.Duration>getExtraVisitDurationForVisitType()Deprecated.intgetExtraVisitDurationForVisitTypeCount()Specifies a map from visit_types strings to durations.Map<String,com.google.protobuf.Duration>getExtraVisitDurationForVisitTypeMap()Specifies a map from visit_types strings to durations.com.google.protobuf.DurationgetExtraVisitDurationForVisitTypeOrDefault(String key, com.google.protobuf.Duration defaultValue)Specifies a map from visit_types strings to durations.com.google.protobuf.DurationgetExtraVisitDurationForVisitTypeOrThrow(String key)Specifies a map from visit_types strings to durations.doublegetFixedCost()Fixed cost applied if this vehicle is used to handle a shipment.booleangetIgnore()If true, `used_if_route_is_empty` must be false, and this vehicle will remain unused.StringgetLabel()Specifies a label for this vehicle.com.google.protobuf.ByteStringgetLabelBytes()Specifies a label for this vehicle.Map<String,Vehicle.LoadLimit>getLoadLimits()Deprecated.intgetLoadLimitsCount()Capacities of the vehicle (weight, volume, # of pallets for example).Map<String,Vehicle.LoadLimit>getLoadLimitsMap()Capacities of the vehicle (weight, volume, # of pallets for example).Vehicle.LoadLimitgetLoadLimitsOrDefault(String key, Vehicle.LoadLimit defaultValue)Capacities of the vehicle (weight, volume, # of pallets for example).Vehicle.LoadLimitgetLoadLimitsOrThrow(String key)Capacities of the vehicle (weight, volume, # of pallets for example).com.google.protobuf.Parser<Vehicle>getParserForType()DistanceLimitgetRouteDistanceLimit()Limit applied to the total distance of the vehicle's route.DistanceLimitOrBuildergetRouteDistanceLimitOrBuilder()Limit applied to the total distance of the vehicle's route.Vehicle.DurationLimitgetRouteDurationLimit()Limit applied to the total duration of the vehicle's route.Vehicle.DurationLimitOrBuildergetRouteDurationLimitOrBuilder()Limit applied to the total duration of the vehicle's route.intgetSerializedSize()CapacityQuantityIntervalgetStartLoadIntervals(int index)Deprecated.intgetStartLoadIntervalsCount()Deprecated.List<CapacityQuantityInterval>getStartLoadIntervalsList()Deprecated.CapacityQuantityIntervalOrBuildergetStartLoadIntervalsOrBuilder(int index)Deprecated.List<? extends CapacityQuantityIntervalOrBuilder>getStartLoadIntervalsOrBuilderList()Deprecated.com.google.type.LatLnggetStartLocation()Geographic location where the vehicle starts before picking up any shipments.com.google.type.LatLngOrBuildergetStartLocationOrBuilder()Geographic location where the vehicle starts before picking up any shipments.StringgetStartTags(int index)Specifies tags attached to the start of the vehicle's route.com.google.protobuf.ByteStringgetStartTagsBytes(int index)Specifies tags attached to the start of the vehicle's route.intgetStartTagsCount()Specifies tags attached to the start of the vehicle's route.com.google.protobuf.ProtocolStringListgetStartTagsList()Specifies tags attached to the start of the vehicle's route.TimeWindowgetStartTimeWindows(int index)Time windows during which the vehicle may depart its start location.intgetStartTimeWindowsCount()Time windows during which the vehicle may depart its start location.List<TimeWindow>getStartTimeWindowsList()Time windows during which the vehicle may depart its start location.TimeWindowOrBuildergetStartTimeWindowsOrBuilder(int index)Time windows during which the vehicle may depart its start location.List<? extends TimeWindowOrBuilder>getStartTimeWindowsOrBuilderList()Time windows during which the vehicle may depart its start location.WaypointgetStartWaypoint()Waypoint representing a geographic location where the vehicle starts before picking up any shipments.WaypointOrBuildergetStartWaypointOrBuilder()Waypoint representing a geographic location where the vehicle starts before picking up any shipments.Vehicle.DurationLimitgetTravelDurationLimit()Limit applied to the travel duration of the vehicle's route.Vehicle.DurationLimitOrBuildergetTravelDurationLimitOrBuilder()Limit applied to the travel duration of the vehicle's route.doublegetTravelDurationMultiple()Specifies a multiplicative factor that can be used to increase or decrease travel times of this vehicle.Vehicle.TravelModegetTravelMode()The travel mode which affects the roads usable by the vehicle and its speed.intgetTravelModeValue()The travel mode which affects the roads usable by the vehicle and its speed.Vehicle.UnloadingPolicygetUnloadingPolicy()Unloading policy enforced on the vehicle.intgetUnloadingPolicyValue()Unloading policy enforced on the vehicle.booleangetUsedIfRouteIsEmpty()This field only applies to vehicles when their route does not serve any shipments.booleanhasBreakRule()Describes the break schedule to be enforced on this vehicle.booleanhasEndLocation()Geographic location where the vehicle ends after it has completed its last `VisitRequest`.booleanhasEndWaypoint()Waypoint representing a geographic location where the vehicle ends after it has completed its last `VisitRequest`.inthashCode()booleanhasRouteDistanceLimit()Limit applied to the total distance of the vehicle's route.booleanhasRouteDurationLimit()Limit applied to the total duration of the vehicle's route.booleanhasStartLocation()Geographic location where the vehicle starts before picking up any shipments.booleanhasStartWaypoint()Waypoint representing a geographic location where the vehicle starts before picking up any shipments.booleanhasTravelDurationLimit()Limit applied to the travel duration of the vehicle's route.booleanhasTravelDurationMultiple()Specifies a multiplicative factor that can be used to increase or decrease travel times of this vehicle.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)booleanisInitialized()static Vehicle.BuildernewBuilder()static Vehicle.BuildernewBuilder(Vehicle prototype)Vehicle.BuildernewBuilderForType()protected Vehicle.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static VehicleparseDelimitedFrom(InputStream input)static VehicleparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static VehicleparseFrom(byte[] data)static VehicleparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static VehicleparseFrom(com.google.protobuf.ByteString data)static VehicleparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static VehicleparseFrom(com.google.protobuf.CodedInputStream input)static VehicleparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static VehicleparseFrom(InputStream input)static VehicleparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static VehicleparseFrom(ByteBuffer data)static VehicleparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<Vehicle>parser()Vehicle.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
TRAVEL_MODE_FIELD_NUMBER
public static final int TRAVEL_MODE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
START_LOCATION_FIELD_NUMBER
public static final int START_LOCATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
START_WAYPOINT_FIELD_NUMBER
public static final int START_WAYPOINT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
END_LOCATION_FIELD_NUMBER
public static final int END_LOCATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
END_WAYPOINT_FIELD_NUMBER
public static final int END_WAYPOINT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
START_TAGS_FIELD_NUMBER
public static final int START_TAGS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
END_TAGS_FIELD_NUMBER
public static final int END_TAGS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
START_TIME_WINDOWS_FIELD_NUMBER
public static final int START_TIME_WINDOWS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
END_TIME_WINDOWS_FIELD_NUMBER
public static final int END_TIME_WINDOWS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TRAVEL_DURATION_MULTIPLE_FIELD_NUMBER
public static final int TRAVEL_DURATION_MULTIPLE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
UNLOADING_POLICY_FIELD_NUMBER
public static final int UNLOADING_POLICY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LOAD_LIMITS_FIELD_NUMBER
public static final int LOAD_LIMITS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
COST_PER_HOUR_FIELD_NUMBER
public static final int COST_PER_HOUR_FIELD_NUMBER
- See Also:
- Constant Field Values
-
COST_PER_TRAVELED_HOUR_FIELD_NUMBER
public static final int COST_PER_TRAVELED_HOUR_FIELD_NUMBER
- See Also:
- Constant Field Values
-
COST_PER_KILOMETER_FIELD_NUMBER
public static final int COST_PER_KILOMETER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FIXED_COST_FIELD_NUMBER
public static final int FIXED_COST_FIELD_NUMBER
- See Also:
- Constant Field Values
-
USED_IF_ROUTE_IS_EMPTY_FIELD_NUMBER
public static final int USED_IF_ROUTE_IS_EMPTY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ROUTE_DURATION_LIMIT_FIELD_NUMBER
public static final int ROUTE_DURATION_LIMIT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TRAVEL_DURATION_LIMIT_FIELD_NUMBER
public static final int TRAVEL_DURATION_LIMIT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ROUTE_DISTANCE_LIMIT_FIELD_NUMBER
public static final int ROUTE_DISTANCE_LIMIT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
EXTRA_VISIT_DURATION_FOR_VISIT_TYPE_FIELD_NUMBER
public static final int EXTRA_VISIT_DURATION_FOR_VISIT_TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BREAK_RULE_FIELD_NUMBER
public static final int BREAK_RULE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LABEL_FIELD_NUMBER
public static final int LABEL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
IGNORE_FIELD_NUMBER
public static final int IGNORE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BREAK_RULE_INDICES_FIELD_NUMBER
public static final int BREAK_RULE_INDICES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CAPACITIES_FIELD_NUMBER
public static final int CAPACITIES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
START_LOAD_INTERVALS_FIELD_NUMBER
public static final int START_LOAD_INTERVALS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
END_LOAD_INTERVALS_FIELD_NUMBER
public static final int END_LOAD_INTERVALS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
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;- Specified by:
getTravelModeValuein interfaceVehicleOrBuilder- Returns:
- The enum numeric value on the wire for travelMode.
-
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;- Specified by:
getTravelModein interfaceVehicleOrBuilder- Returns:
- The travelMode.
-
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;- Specified by:
hasStartLocationin interfaceVehicleOrBuilder- Returns:
- Whether the startLocation field is set.
-
getStartLocation
public com.google.type.LatLng getStartLocation()
Geographic location where the vehicle starts before picking up any shipments. If not specified, the vehicle starts at its first pickup. If the shipment model has duration and distance matrices, `start_location` must not be specified.
.google.type.LatLng start_location = 3;- Specified by:
getStartLocationin interfaceVehicleOrBuilder- Returns:
- The startLocation.
-
getStartLocationOrBuilder
public com.google.type.LatLngOrBuilder getStartLocationOrBuilder()
Geographic location where the vehicle starts before picking up any shipments. If not specified, the vehicle starts at its first pickup. If the shipment model has duration and distance matrices, `start_location` must not be specified.
.google.type.LatLng start_location = 3;- Specified by:
getStartLocationOrBuilderin interfaceVehicleOrBuilder
-
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;- Specified by:
hasStartWaypointin interfaceVehicleOrBuilder- Returns:
- Whether the startWaypoint field is set.
-
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;- Specified by:
getStartWaypointin interfaceVehicleOrBuilder- Returns:
- The startWaypoint.
-
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;- Specified by:
getStartWaypointOrBuilderin interfaceVehicleOrBuilder
-
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;- Specified by:
hasEndLocationin interfaceVehicleOrBuilder- Returns:
- Whether the endLocation field is set.
-
getEndLocation
public com.google.type.LatLng getEndLocation()
Geographic location where the vehicle ends after it has completed its last `VisitRequest`. If not specified the vehicle's `ShipmentRoute` ends immediately when it completes its last `VisitRequest`. If the shipment model has duration and distance matrices, `end_location` must not be specified.
.google.type.LatLng end_location = 5;- Specified by:
getEndLocationin interfaceVehicleOrBuilder- Returns:
- The endLocation.
-
getEndLocationOrBuilder
public com.google.type.LatLngOrBuilder getEndLocationOrBuilder()
Geographic location where the vehicle ends after it has completed its last `VisitRequest`. If not specified the vehicle's `ShipmentRoute` ends immediately when it completes its last `VisitRequest`. If the shipment model has duration and distance matrices, `end_location` must not be specified.
.google.type.LatLng end_location = 5;- Specified by:
getEndLocationOrBuilderin interfaceVehicleOrBuilder
-
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;- Specified by:
hasEndWaypointin interfaceVehicleOrBuilder- Returns:
- Whether the endWaypoint field is set.
-
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;- Specified by:
getEndWaypointin interfaceVehicleOrBuilder- Returns:
- The endWaypoint.
-
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;- Specified by:
getEndWaypointOrBuilderin interfaceVehicleOrBuilder
-
getStartTagsList
public com.google.protobuf.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;- Specified by:
getStartTagsListin interfaceVehicleOrBuilder- Returns:
- A list containing the startTags.
-
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;- Specified by:
getStartTagsCountin interfaceVehicleOrBuilder- Returns:
- The count of startTags.
-
getStartTags
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;- Specified by:
getStartTagsin interfaceVehicleOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The startTags at the given index.
-
getStartTagsBytes
public com.google.protobuf.ByteString getStartTagsBytes(int index)
Specifies tags attached to the start of the vehicle's route. Empty or duplicate strings are not allowed.
repeated string start_tags = 7;- Specified by:
getStartTagsBytesin interfaceVehicleOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the startTags at the given index.
-
getEndTagsList
public com.google.protobuf.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;- Specified by:
getEndTagsListin interfaceVehicleOrBuilder- Returns:
- A list containing the endTags.
-
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;- Specified by:
getEndTagsCountin interfaceVehicleOrBuilder- Returns:
- The count of endTags.
-
getEndTags
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;- Specified by:
getEndTagsin interfaceVehicleOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The endTags at the given index.
-
getEndTagsBytes
public com.google.protobuf.ByteString getEndTagsBytes(int index)
Specifies tags attached to the end of the vehicle's route. Empty or duplicate strings are not allowed.
repeated string end_tags = 8;- Specified by:
getEndTagsBytesin interfaceVehicleOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the endTags at the given index.
-
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_*][google.cloud.optimization.v1.ShipmentModel.global_start_time] fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window.
repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;- Specified by:
getStartTimeWindowsListin interfaceVehicleOrBuilder
-
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_*][google.cloud.optimization.v1.ShipmentModel.global_start_time] fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window.
repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;- Specified by:
getStartTimeWindowsOrBuilderListin interfaceVehicleOrBuilder
-
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_*][google.cloud.optimization.v1.ShipmentModel.global_start_time] fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window.
repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;- Specified by:
getStartTimeWindowsCountin interfaceVehicleOrBuilder
-
getStartTimeWindows
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_*][google.cloud.optimization.v1.ShipmentModel.global_start_time] fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window.
repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;- Specified by:
getStartTimeWindowsin interfaceVehicleOrBuilder
-
getStartTimeWindowsOrBuilder
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_*][google.cloud.optimization.v1.ShipmentModel.global_start_time] fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window.
repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;- Specified by:
getStartTimeWindowsOrBuilderin interfaceVehicleOrBuilder
-
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_*][google.cloud.optimization.v1.ShipmentModel.global_start_time] fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window.
repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;- Specified by:
getEndTimeWindowsListin interfaceVehicleOrBuilder
-
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_*][google.cloud.optimization.v1.ShipmentModel.global_start_time] fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window.
repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;- Specified by:
getEndTimeWindowsOrBuilderListin interfaceVehicleOrBuilder
-
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_*][google.cloud.optimization.v1.ShipmentModel.global_start_time] fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window.
repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;- Specified by:
getEndTimeWindowsCountin interfaceVehicleOrBuilder
-
getEndTimeWindows
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_*][google.cloud.optimization.v1.ShipmentModel.global_start_time] fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window.
repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;- Specified by:
getEndTimeWindowsin interfaceVehicleOrBuilder
-
getEndTimeWindowsOrBuilder
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_*][google.cloud.optimization.v1.ShipmentModel.global_start_time] fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window.
repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;- Specified by:
getEndTimeWindowsOrBuilderin interfaceVehicleOrBuilder
-
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;- Specified by:
hasTravelDurationMultiplein interfaceVehicleOrBuilder- Returns:
- Whether the travelDurationMultiple field is set.
-
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;- Specified by:
getTravelDurationMultiplein interfaceVehicleOrBuilder- Returns:
- The travelDurationMultiple.
-
getUnloadingPolicyValue
public int getUnloadingPolicyValue()
Unloading policy enforced on the vehicle.
.google.cloud.optimization.v1.Vehicle.UnloadingPolicy unloading_policy = 12;- Specified by:
getUnloadingPolicyValuein interfaceVehicleOrBuilder- Returns:
- The enum numeric value on the wire for unloadingPolicy.
-
getUnloadingPolicy
public Vehicle.UnloadingPolicy getUnloadingPolicy()
Unloading policy enforced on the vehicle.
.google.cloud.optimization.v1.Vehicle.UnloadingPolicy unloading_policy = 12;- Specified by:
getUnloadingPolicyin interfaceVehicleOrBuilder- Returns:
- The unloadingPolicy.
-
getLoadLimitsCount
public int getLoadLimitsCount()
Description copied from interface:VehicleOrBuilderCapacities of the vehicle (weight, volume, # of pallets for example). The keys in the map are the identifiers of the type of load, consistent with the keys of the [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] field. If a given key is absent from this map, the corresponding capacity is considered to be limitless.
map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;- Specified by:
getLoadLimitsCountin interfaceVehicleOrBuilder
-
containsLoadLimits
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][google.cloud.optimization.v1.Shipment.load_demands] field. If a given key is absent from this map, the corresponding capacity is considered to be limitless.
map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;- Specified by:
containsLoadLimitsin interfaceVehicleOrBuilder
-
getLoadLimits
@Deprecated public Map<String,Vehicle.LoadLimit> getLoadLimits()
Deprecated.UsegetLoadLimitsMap()instead.- Specified by:
getLoadLimitsin interfaceVehicleOrBuilder
-
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][google.cloud.optimization.v1.Shipment.load_demands] field. If a given key is absent from this map, the corresponding capacity is considered to be limitless.
map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;- Specified by:
getLoadLimitsMapin interfaceVehicleOrBuilder
-
getLoadLimitsOrDefault
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][google.cloud.optimization.v1.Shipment.load_demands] field. If a given key is absent from this map, the corresponding capacity is considered to be limitless.
map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;- Specified by:
getLoadLimitsOrDefaultin interfaceVehicleOrBuilder
-
getLoadLimitsOrThrow
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][google.cloud.optimization.v1.Shipment.load_demands] field. If a given key is absent from this map, the corresponding capacity is considered to be limitless.
map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;- Specified by:
getLoadLimitsOrThrowin interfaceVehicleOrBuilder
-
getCostPerHour
public double getCostPerHour()
Vehicle costs: all costs add up and must be in the same unit as [Shipment.penalty_cost][google.cloud.optimization.v1.Shipment.penalty_cost]. Cost per hour of the vehicle route. This cost is applied to the total time taken by the route, and includes travel time, waiting time, and visit time. Using `cost_per_hour` instead of just `cost_per_traveled_hour` may result in additional latency.
double cost_per_hour = 16;- Specified by:
getCostPerHourin interfaceVehicleOrBuilder- Returns:
- The costPerHour.
-
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][google.cloud.optimization.v1.ShipmentRoute.transitions]), and excludes waiting time and visit time.
double cost_per_traveled_hour = 17;- Specified by:
getCostPerTraveledHourin interfaceVehicleOrBuilder- Returns:
- The costPerTraveledHour.
-
getCostPerKilometer
public double getCostPerKilometer()
Cost per kilometer of the vehicle route. This cost is applied to the distance reported in the [ShipmentRoute.transitions][google.cloud.optimization.v1.ShipmentRoute.transitions] and does not apply to any distance implicitly traveled from the `arrival_location` to the `departure_location` of a single `VisitRequest`.
double cost_per_kilometer = 18;- Specified by:
getCostPerKilometerin interfaceVehicleOrBuilder- Returns:
- The costPerKilometer.
-
getFixedCost
public double getFixedCost()
Fixed cost applied if this vehicle is used to handle a shipment.
double fixed_cost = 19;- Specified by:
getFixedCostin interfaceVehicleOrBuilder- Returns:
- The fixedCost.
-
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;- Specified by:
getUsedIfRouteIsEmptyin interfaceVehicleOrBuilder- Returns:
- The usedIfRouteIsEmpty.
-
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;- Specified by:
hasRouteDurationLimitin interfaceVehicleOrBuilder- Returns:
- Whether the routeDurationLimit field is set.
-
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;- Specified by:
getRouteDurationLimitin interfaceVehicleOrBuilder- Returns:
- The routeDurationLimit.
-
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;- Specified by:
getRouteDurationLimitOrBuilderin interfaceVehicleOrBuilder
-
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.ShipmentRoute.Transition.travel_duration].
.google.cloud.optimization.v1.Vehicle.DurationLimit travel_duration_limit = 22;- Specified by:
hasTravelDurationLimitin interfaceVehicleOrBuilder- Returns:
- Whether the travelDurationLimit field is set.
-
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.ShipmentRoute.Transition.travel_duration].
.google.cloud.optimization.v1.Vehicle.DurationLimit travel_duration_limit = 22;- Specified by:
getTravelDurationLimitin interfaceVehicleOrBuilder- Returns:
- The travelDurationLimit.
-
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.ShipmentRoute.Transition.travel_duration].
.google.cloud.optimization.v1.Vehicle.DurationLimit travel_duration_limit = 22;- Specified by:
getTravelDurationLimitOrBuilderin interfaceVehicleOrBuilder
-
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.ShipmentRoute.Transition.travel_distance_meters].
.google.cloud.optimization.v1.DistanceLimit route_distance_limit = 23;- Specified by:
hasRouteDistanceLimitin interfaceVehicleOrBuilder- Returns:
- Whether the routeDistanceLimit field is set.
-
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.ShipmentRoute.Transition.travel_distance_meters].
.google.cloud.optimization.v1.DistanceLimit route_distance_limit = 23;- Specified by:
getRouteDistanceLimitin interfaceVehicleOrBuilder- Returns:
- The routeDistanceLimit.
-
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.ShipmentRoute.Transition.travel_distance_meters].
.google.cloud.optimization.v1.DistanceLimit route_distance_limit = 23;- Specified by:
getRouteDistanceLimitOrBuilderin interfaceVehicleOrBuilder
-
getExtraVisitDurationForVisitTypeCount
public int getExtraVisitDurationForVisitTypeCount()
Description copied from interface:VehicleOrBuilderSpecifies a map from visit_types strings to durations. The duration is time in addition to [VisitRequest.duration][google.cloud.optimization.v1.Shipment.VisitRequest.duration] to be taken at visits with the specified `visit_types`. This extra visit duration adds cost if `cost_per_hour` is specified. Keys (i.e. `visit_types`) cannot be empty strings. If a visit request has multiple types, a duration will be added for each type in the map.
map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;- Specified by:
getExtraVisitDurationForVisitTypeCountin interfaceVehicleOrBuilder
-
containsExtraVisitDurationForVisitType
public boolean containsExtraVisitDurationForVisitType(String key)
Specifies a map from visit_types strings to durations. The duration is time in addition to [VisitRequest.duration][google.cloud.optimization.v1.Shipment.VisitRequest.duration] to be taken at visits with the specified `visit_types`. This extra visit duration adds cost if `cost_per_hour` is specified. Keys (i.e. `visit_types`) cannot be empty strings. If a visit request has multiple types, a duration will be added for each type in the map.
map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;- Specified by:
containsExtraVisitDurationForVisitTypein interfaceVehicleOrBuilder
-
getExtraVisitDurationForVisitType
@Deprecated public Map<String,com.google.protobuf.Duration> getExtraVisitDurationForVisitType()
Deprecated.UsegetExtraVisitDurationForVisitTypeMap()instead.- Specified by:
getExtraVisitDurationForVisitTypein interfaceVehicleOrBuilder
-
getExtraVisitDurationForVisitTypeMap
public Map<String,com.google.protobuf.Duration> getExtraVisitDurationForVisitTypeMap()
Specifies a map from visit_types strings to durations. The duration is time in addition to [VisitRequest.duration][google.cloud.optimization.v1.Shipment.VisitRequest.duration] to be taken at visits with the specified `visit_types`. This extra visit duration adds cost if `cost_per_hour` is specified. Keys (i.e. `visit_types`) cannot be empty strings. If a visit request has multiple types, a duration will be added for each type in the map.
map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;- Specified by:
getExtraVisitDurationForVisitTypeMapin interfaceVehicleOrBuilder
-
getExtraVisitDurationForVisitTypeOrDefault
public com.google.protobuf.Duration getExtraVisitDurationForVisitTypeOrDefault(String key, com.google.protobuf.Duration defaultValue)
Specifies a map from visit_types strings to durations. The duration is time in addition to [VisitRequest.duration][google.cloud.optimization.v1.Shipment.VisitRequest.duration] to be taken at visits with the specified `visit_types`. This extra visit duration adds cost if `cost_per_hour` is specified. Keys (i.e. `visit_types`) cannot be empty strings. If a visit request has multiple types, a duration will be added for each type in the map.
map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;- Specified by:
getExtraVisitDurationForVisitTypeOrDefaultin interfaceVehicleOrBuilder
-
getExtraVisitDurationForVisitTypeOrThrow
public com.google.protobuf.Duration getExtraVisitDurationForVisitTypeOrThrow(String key)
Specifies a map from visit_types strings to durations. The duration is time in addition to [VisitRequest.duration][google.cloud.optimization.v1.Shipment.VisitRequest.duration] to be taken at visits with the specified `visit_types`. This extra visit duration adds cost if `cost_per_hour` is specified. Keys (i.e. `visit_types`) cannot be empty strings. If a visit request has multiple types, a duration will be added for each type in the map.
map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;- Specified by:
getExtraVisitDurationForVisitTypeOrThrowin interfaceVehicleOrBuilder
-
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;- Specified by:
hasBreakRulein interfaceVehicleOrBuilder- Returns:
- Whether the breakRule field is set.
-
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;- Specified by:
getBreakRulein interfaceVehicleOrBuilder- Returns:
- The breakRule.
-
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;- Specified by:
getBreakRuleOrBuilderin interfaceVehicleOrBuilder
-
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][google.cloud.optimization.v1.ShipmentRoute].
string label = 27;- Specified by:
getLabelin interfaceVehicleOrBuilder- Returns:
- The label.
-
getLabelBytes
public com.google.protobuf.ByteString getLabelBytes()
Specifies a label for this vehicle. This label is reported in the response as the `vehicle_label` of the corresponding [ShipmentRoute][google.cloud.optimization.v1.ShipmentRoute].
string label = 27;- Specified by:
getLabelBytesin interfaceVehicleOrBuilder- Returns:
- The bytes for label.
-
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;- Specified by:
getIgnorein interfaceVehicleOrBuilder- Returns:
- The ignore.
-
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=1454Deprecated: No longer used. Indices in the `break_rule` field in the source [ShipmentModel][google.cloud.optimization.v1.ShipmentModel]. They correspond to break rules enforced on the vehicle. As of 2018/03, at most one rule index per vehicle can be specified.
repeated int32 break_rule_indices = 29 [deprecated = true];- Specified by:
getBreakRuleIndicesListin interfaceVehicleOrBuilder- Returns:
- A list containing the breakRuleIndices.
-
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=1454Deprecated: No longer used. Indices in the `break_rule` field in the source [ShipmentModel][google.cloud.optimization.v1.ShipmentModel]. They correspond to break rules enforced on the vehicle. As of 2018/03, at most one rule index per vehicle can be specified.
repeated int32 break_rule_indices = 29 [deprecated = true];- Specified by:
getBreakRuleIndicesCountin interfaceVehicleOrBuilder- Returns:
- The count of breakRuleIndices.
-
getBreakRuleIndices
@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=1454Deprecated: No longer used. Indices in the `break_rule` field in the source [ShipmentModel][google.cloud.optimization.v1.ShipmentModel]. They correspond to break rules enforced on the vehicle. As of 2018/03, at most one rule index per vehicle can be specified.
repeated int32 break_rule_indices = 29 [deprecated = true];- Specified by:
getBreakRuleIndicesin interfaceVehicleOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The breakRuleIndices at the given index.
-
getCapacitiesList
@Deprecated public List<CapacityQuantity> getCapacitiesList()
Deprecated.Deprecated: Use [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];- Specified by:
getCapacitiesListin interfaceVehicleOrBuilder
-
getCapacitiesOrBuilderList
@Deprecated public List<? extends CapacityQuantityOrBuilder> getCapacitiesOrBuilderList()
Deprecated.Deprecated: Use [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];- Specified by:
getCapacitiesOrBuilderListin interfaceVehicleOrBuilder
-
getCapacitiesCount
@Deprecated public int getCapacitiesCount()
Deprecated.Deprecated: Use [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];- Specified by:
getCapacitiesCountin interfaceVehicleOrBuilder
-
getCapacities
@Deprecated public CapacityQuantity getCapacities(int index)
Deprecated.Deprecated: Use [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];- Specified by:
getCapacitiesin interfaceVehicleOrBuilder
-
getCapacitiesOrBuilder
@Deprecated public CapacityQuantityOrBuilder getCapacitiesOrBuilder(int index)
Deprecated.Deprecated: Use [Vehicle.load_limits][google.cloud.optimization.v1.Vehicle.load_limits] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity capacities = 13 [deprecated = true];- Specified by:
getCapacitiesOrBuilderin interfaceVehicleOrBuilder
-
getStartLoadIntervalsList
@Deprecated public List<CapacityQuantityInterval> getStartLoadIntervalsList()
Deprecated.Deprecated: Use [Vehicle.LoadLimit.start_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.start_load_interval] instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];- Specified by:
getStartLoadIntervalsListin interfaceVehicleOrBuilder
-
getStartLoadIntervalsOrBuilderList
@Deprecated public List<? extends CapacityQuantityIntervalOrBuilder> getStartLoadIntervalsOrBuilderList()
Deprecated.Deprecated: Use [Vehicle.LoadLimit.start_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.start_load_interval] instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];- Specified by:
getStartLoadIntervalsOrBuilderListin interfaceVehicleOrBuilder
-
getStartLoadIntervalsCount
@Deprecated public int getStartLoadIntervalsCount()
Deprecated.Deprecated: Use [Vehicle.LoadLimit.start_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.start_load_interval] instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];- Specified by:
getStartLoadIntervalsCountin interfaceVehicleOrBuilder
-
getStartLoadIntervals
@Deprecated public CapacityQuantityInterval getStartLoadIntervals(int index)
Deprecated.Deprecated: Use [Vehicle.LoadLimit.start_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.start_load_interval] instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];- Specified by:
getStartLoadIntervalsin interfaceVehicleOrBuilder
-
getStartLoadIntervalsOrBuilder
@Deprecated public CapacityQuantityIntervalOrBuilder getStartLoadIntervalsOrBuilder(int index)
Deprecated.Deprecated: Use [Vehicle.LoadLimit.start_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.start_load_interval] instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval start_load_intervals = 14 [deprecated = true];- Specified by:
getStartLoadIntervalsOrBuilderin interfaceVehicleOrBuilder
-
getEndLoadIntervalsList
@Deprecated public List<CapacityQuantityInterval> getEndLoadIntervalsList()
Deprecated.Deprecated: Use [Vehicle.LoadLimit.end_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.end_load_interval] instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];- Specified by:
getEndLoadIntervalsListin interfaceVehicleOrBuilder
-
getEndLoadIntervalsOrBuilderList
@Deprecated public List<? extends CapacityQuantityIntervalOrBuilder> getEndLoadIntervalsOrBuilderList()
Deprecated.Deprecated: Use [Vehicle.LoadLimit.end_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.end_load_interval] instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];- Specified by:
getEndLoadIntervalsOrBuilderListin interfaceVehicleOrBuilder
-
getEndLoadIntervalsCount
@Deprecated public int getEndLoadIntervalsCount()
Deprecated.Deprecated: Use [Vehicle.LoadLimit.end_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.end_load_interval] instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];- Specified by:
getEndLoadIntervalsCountin interfaceVehicleOrBuilder
-
getEndLoadIntervals
@Deprecated public CapacityQuantityInterval getEndLoadIntervals(int index)
Deprecated.Deprecated: Use [Vehicle.LoadLimit.end_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.end_load_interval] instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];- Specified by:
getEndLoadIntervalsin interfaceVehicleOrBuilder
-
getEndLoadIntervalsOrBuilder
@Deprecated public CapacityQuantityIntervalOrBuilder getEndLoadIntervalsOrBuilder(int index)
Deprecated.Deprecated: Use [Vehicle.LoadLimit.end_load_interval][google.cloud.optimization.v1.Vehicle.LoadLimit.end_load_interval] instead.
repeated .google.cloud.optimization.v1.CapacityQuantityInterval end_load_intervals = 15 [deprecated = true];- Specified by:
getEndLoadIntervalsOrBuilderin interfaceVehicleOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Vehicle parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Vehicle parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Vehicle parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Vehicle parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Vehicle parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Vehicle parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Vehicle parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Vehicle parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Vehicle parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Vehicle parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static Vehicle parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Vehicle parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public Vehicle.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Vehicle.Builder newBuilder()
-
newBuilder
public static Vehicle.Builder newBuilder(Vehicle prototype)
-
toBuilder
public Vehicle.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Vehicle.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static Vehicle getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Vehicle> parser()
-
getParserForType
public com.google.protobuf.Parser<Vehicle> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Vehicle getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-