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 class
Vehicle.Builder
Models a vehicle in a shipment problem.static class
Vehicle.DurationLimit
A limit defining a maximum duration of the route of a vehicle.static interface
Vehicle.DurationLimitOrBuilder
static class
Vehicle.LoadLimit
Defines a load limit applying to a vehicle, e.g.static interface
Vehicle.LoadLimitOrBuilder
static class
Vehicle.TravelMode
Travel modes which can be used by vehicles.static class
Vehicle.UnloadingPolicy
Policy 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 boolean
containsExtraVisitDurationForVisitType(String key)
Specifies a map from visit_types strings to durations.boolean
containsLoadLimits(String key)
Capacities of the vehicle (weight, volume, # of pallets for example).boolean
equals(Object obj)
BreakRule
getBreakRule()
Describes the break schedule to be enforced on this vehicle.int
getBreakRuleIndices(int index)
Deprecated.google.cloud.optimization.v1.Vehicle.break_rule_indices is deprecated.int
getBreakRuleIndicesCount()
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.BreakRuleOrBuilder
getBreakRuleOrBuilder()
Describes the break schedule to be enforced on this vehicle.CapacityQuantity
getCapacities(int index)
Deprecated.int
getCapacitiesCount()
Deprecated.List<CapacityQuantity>
getCapacitiesList()
Deprecated.CapacityQuantityOrBuilder
getCapacitiesOrBuilder(int index)
Deprecated.List<? extends CapacityQuantityOrBuilder>
getCapacitiesOrBuilderList()
Deprecated.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].double
getCostPerKilometer()
Cost per kilometer of the vehicle route.double
getCostPerTraveledHour()
Cost per traveled hour of the vehicle route.static Vehicle
getDefaultInstance()
Vehicle
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
CapacityQuantityInterval
getEndLoadIntervals(int index)
Deprecated.int
getEndLoadIntervalsCount()
Deprecated.List<CapacityQuantityInterval>
getEndLoadIntervalsList()
Deprecated.CapacityQuantityIntervalOrBuilder
getEndLoadIntervalsOrBuilder(int index)
Deprecated.List<? extends CapacityQuantityIntervalOrBuilder>
getEndLoadIntervalsOrBuilderList()
Deprecated.com.google.type.LatLng
getEndLocation()
Geographic location where the vehicle ends after it has completed its last `VisitRequest`.com.google.type.LatLngOrBuilder
getEndLocationOrBuilder()
Geographic location where the vehicle ends after it has completed its last `VisitRequest`.String
getEndTags(int index)
Specifies tags attached to the end of the vehicle's route.com.google.protobuf.ByteString
getEndTagsBytes(int index)
Specifies tags attached to the end of the vehicle's route.int
getEndTagsCount()
Specifies tags attached to the end of the vehicle's route.com.google.protobuf.ProtocolStringList
getEndTagsList()
Specifies tags attached to the end of the vehicle's route.TimeWindow
getEndTimeWindows(int index)
Time windows during which the vehicle may arrive at its end location.int
getEndTimeWindowsCount()
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.TimeWindowOrBuilder
getEndTimeWindowsOrBuilder(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.Waypoint
getEndWaypoint()
Waypoint representing a geographic location where the vehicle ends after it has completed its last `VisitRequest`.WaypointOrBuilder
getEndWaypointOrBuilder()
Waypoint representing a geographic location where the vehicle ends after it has completed its last `VisitRequest`.Map<String,com.google.protobuf.Duration>
getExtraVisitDurationForVisitType()
Deprecated.int
getExtraVisitDurationForVisitTypeCount()
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.Duration
getExtraVisitDurationForVisitTypeOrDefault(String key, com.google.protobuf.Duration defaultValue)
Specifies a map from visit_types strings to durations.com.google.protobuf.Duration
getExtraVisitDurationForVisitTypeOrThrow(String key)
Specifies a map from visit_types strings to durations.double
getFixedCost()
Fixed cost applied if this vehicle is used to handle a shipment.boolean
getIgnore()
If true, `used_if_route_is_empty` must be false, and this vehicle will remain unused.String
getLabel()
Specifies a label for this vehicle.com.google.protobuf.ByteString
getLabelBytes()
Specifies a label for this vehicle.Map<String,Vehicle.LoadLimit>
getLoadLimits()
Deprecated.int
getLoadLimitsCount()
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.LoadLimit
getLoadLimitsOrDefault(String key, Vehicle.LoadLimit defaultValue)
Capacities of the vehicle (weight, volume, # of pallets for example).Vehicle.LoadLimit
getLoadLimitsOrThrow(String key)
Capacities of the vehicle (weight, volume, # of pallets for example).com.google.protobuf.Parser<Vehicle>
getParserForType()
DistanceLimit
getRouteDistanceLimit()
Limit applied to the total distance of the vehicle's route.DistanceLimitOrBuilder
getRouteDistanceLimitOrBuilder()
Limit applied to the total distance of the vehicle's route.Vehicle.DurationLimit
getRouteDurationLimit()
Limit applied to the total duration of the vehicle's route.Vehicle.DurationLimitOrBuilder
getRouteDurationLimitOrBuilder()
Limit applied to the total duration of the vehicle's route.int
getSerializedSize()
CapacityQuantityInterval
getStartLoadIntervals(int index)
Deprecated.int
getStartLoadIntervalsCount()
Deprecated.List<CapacityQuantityInterval>
getStartLoadIntervalsList()
Deprecated.CapacityQuantityIntervalOrBuilder
getStartLoadIntervalsOrBuilder(int index)
Deprecated.List<? extends CapacityQuantityIntervalOrBuilder>
getStartLoadIntervalsOrBuilderList()
Deprecated.com.google.type.LatLng
getStartLocation()
Geographic location where the vehicle starts before picking up any shipments.com.google.type.LatLngOrBuilder
getStartLocationOrBuilder()
Geographic location where the vehicle starts before picking up any shipments.String
getStartTags(int index)
Specifies tags attached to the start of the vehicle's route.com.google.protobuf.ByteString
getStartTagsBytes(int index)
Specifies tags attached to the start of the vehicle's route.int
getStartTagsCount()
Specifies tags attached to the start of the vehicle's route.com.google.protobuf.ProtocolStringList
getStartTagsList()
Specifies tags attached to the start of the vehicle's route.TimeWindow
getStartTimeWindows(int index)
Time windows during which the vehicle may depart its start location.int
getStartTimeWindowsCount()
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.TimeWindowOrBuilder
getStartTimeWindowsOrBuilder(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.Waypoint
getStartWaypoint()
Waypoint representing a geographic location where the vehicle starts before picking up any shipments.WaypointOrBuilder
getStartWaypointOrBuilder()
Waypoint representing a geographic location where the vehicle starts before picking up any shipments.Vehicle.DurationLimit
getTravelDurationLimit()
Limit applied to the travel duration of the vehicle's route.Vehicle.DurationLimitOrBuilder
getTravelDurationLimitOrBuilder()
Limit applied to the travel duration of the vehicle's route.double
getTravelDurationMultiple()
Specifies a multiplicative factor that can be used to increase or decrease travel times of this vehicle.Vehicle.TravelMode
getTravelMode()
The travel mode which affects the roads usable by the vehicle and its speed.int
getTravelModeValue()
The travel mode which affects the roads usable by the vehicle and its speed.Vehicle.UnloadingPolicy
getUnloadingPolicy()
Unloading policy enforced on the vehicle.int
getUnloadingPolicyValue()
Unloading policy enforced on the vehicle.boolean
getUsedIfRouteIsEmpty()
This field only applies to vehicles when their route does not serve any shipments.boolean
hasBreakRule()
Describes the break schedule to be enforced on this vehicle.boolean
hasEndLocation()
Geographic location where the vehicle ends after it has completed its last `VisitRequest`.boolean
hasEndWaypoint()
Waypoint representing a geographic location where the vehicle ends after it has completed its last `VisitRequest`.int
hashCode()
boolean
hasRouteDistanceLimit()
Limit applied to the total distance of the vehicle's route.boolean
hasRouteDurationLimit()
Limit applied to the total duration of the vehicle's route.boolean
hasStartLocation()
Geographic location where the vehicle starts before picking up any shipments.boolean
hasStartWaypoint()
Waypoint representing a geographic location where the vehicle starts before picking up any shipments.boolean
hasTravelDurationLimit()
Limit applied to the travel duration of the vehicle's route.boolean
hasTravelDurationMultiple()
Specifies a multiplicative factor that can be used to increase or decrease travel times of this vehicle.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapField
internalGetMapField(int number)
boolean
isInitialized()
static Vehicle.Builder
newBuilder()
static Vehicle.Builder
newBuilder(Vehicle prototype)
Vehicle.Builder
newBuilderForType()
protected Vehicle.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Vehicle
parseDelimitedFrom(InputStream input)
static Vehicle
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Vehicle
parseFrom(byte[] data)
static Vehicle
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Vehicle
parseFrom(com.google.protobuf.ByteString data)
static Vehicle
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Vehicle
parseFrom(com.google.protobuf.CodedInputStream input)
static Vehicle
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Vehicle
parseFrom(InputStream input)
static Vehicle
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Vehicle
parseFrom(ByteBuffer data)
static Vehicle
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Vehicle>
parser()
Vehicle.Builder
toBuilder()
void
writeTo(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:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in 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:
getTravelModeValue
in 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:
getTravelMode
in 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:
hasStartLocation
in 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:
getStartLocation
in 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:
getStartLocationOrBuilder
in 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:
hasStartWaypoint
in 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:
getStartWaypoint
in 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:
getStartWaypointOrBuilder
in 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:
hasEndLocation
in 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:
getEndLocation
in 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:
getEndLocationOrBuilder
in 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:
hasEndWaypoint
in 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:
getEndWaypoint
in 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:
getEndWaypointOrBuilder
in 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:
getStartTagsList
in 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:
getStartTagsCount
in 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:
getStartTags
in 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:
getStartTagsBytes
in 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:
getEndTagsList
in 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:
getEndTagsCount
in 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:
getEndTags
in 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:
getEndTagsBytes
in 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:
getStartTimeWindowsList
in 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:
getStartTimeWindowsOrBuilderList
in 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:
getStartTimeWindowsCount
in 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:
getStartTimeWindows
in 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:
getStartTimeWindowsOrBuilder
in 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:
getEndTimeWindowsList
in 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:
getEndTimeWindowsOrBuilderList
in 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:
getEndTimeWindowsCount
in 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:
getEndTimeWindows
in 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:
getEndTimeWindowsOrBuilder
in 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:
hasTravelDurationMultiple
in 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:
getTravelDurationMultiple
in 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:
getUnloadingPolicyValue
in 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:
getUnloadingPolicy
in interfaceVehicleOrBuilder
- Returns:
- The unloadingPolicy.
-
getLoadLimitsCount
public int getLoadLimitsCount()
Description copied from interface:VehicleOrBuilder
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:
getLoadLimitsCount
in 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:
containsLoadLimits
in interfaceVehicleOrBuilder
-
getLoadLimits
@Deprecated public Map<String,Vehicle.LoadLimit> getLoadLimits()
Deprecated.UsegetLoadLimitsMap()
instead.- Specified by:
getLoadLimits
in 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:
getLoadLimitsMap
in 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:
getLoadLimitsOrDefault
in 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:
getLoadLimitsOrThrow
in 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:
getCostPerHour
in 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:
getCostPerTraveledHour
in 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:
getCostPerKilometer
in 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:
getFixedCost
in 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:
getUsedIfRouteIsEmpty
in 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:
hasRouteDurationLimit
in 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:
getRouteDurationLimit
in 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:
getRouteDurationLimitOrBuilder
in 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:
hasTravelDurationLimit
in 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:
getTravelDurationLimit
in 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:
getTravelDurationLimitOrBuilder
in 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:
hasRouteDistanceLimit
in 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:
getRouteDistanceLimit
in 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:
getRouteDistanceLimitOrBuilder
in interfaceVehicleOrBuilder
-
getExtraVisitDurationForVisitTypeCount
public int getExtraVisitDurationForVisitTypeCount()
Description copied from interface:VehicleOrBuilder
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:
getExtraVisitDurationForVisitTypeCount
in 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:
containsExtraVisitDurationForVisitType
in interfaceVehicleOrBuilder
-
getExtraVisitDurationForVisitType
@Deprecated public Map<String,com.google.protobuf.Duration> getExtraVisitDurationForVisitType()
Deprecated.UsegetExtraVisitDurationForVisitTypeMap()
instead.- Specified by:
getExtraVisitDurationForVisitType
in 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:
getExtraVisitDurationForVisitTypeMap
in 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:
getExtraVisitDurationForVisitTypeOrDefault
in 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:
getExtraVisitDurationForVisitTypeOrThrow
in 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:
hasBreakRule
in 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:
getBreakRule
in 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:
getBreakRuleOrBuilder
in 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:
getLabel
in 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:
getLabelBytes
in 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:
getIgnore
in 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:
getBreakRuleIndicesList
in 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:
getBreakRuleIndicesCount
in 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:
getBreakRuleIndices
in 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:
getCapacitiesList
in 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:
getCapacitiesOrBuilderList
in 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:
getCapacitiesCount
in 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:
getCapacities
in 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:
getCapacitiesOrBuilder
in 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:
getStartLoadIntervalsList
in 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:
getStartLoadIntervalsOrBuilderList
in 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:
getStartLoadIntervalsCount
in 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:
getStartLoadIntervals
in 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:
getStartLoadIntervalsOrBuilder
in 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:
getEndLoadIntervalsList
in 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:
getEndLoadIntervalsOrBuilderList
in 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:
getEndLoadIntervalsCount
in 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:
getEndLoadIntervals
in 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:
getEndLoadIntervalsOrBuilder
in interfaceVehicleOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in 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:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in 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:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Vehicle.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in 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:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Vehicle getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-