Class Vehicle (1.10.0)

public final class Vehicle extends 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 type google.cloud.optimization.v1.Vehicle

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Vehicle

Implements

VehicleOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BREAK_RULE_FIELD_NUMBER

public static final int BREAK_RULE_FIELD_NUMBER

Field Value

Type	Description
`int`

BREAK_RULE_INDICES_FIELD_NUMBER

public static final int BREAK_RULE_INDICES_FIELD_NUMBER

Field Value

Type	Description
`int`

CAPACITIES_FIELD_NUMBER

public static final int CAPACITIES_FIELD_NUMBER

Field Value

Type	Description
`int`

COST_PER_HOUR_FIELD_NUMBER

public static final int COST_PER_HOUR_FIELD_NUMBER

Field Value

Type	Description
`int`

COST_PER_KILOMETER_FIELD_NUMBER

public static final int COST_PER_KILOMETER_FIELD_NUMBER

Field Value

Type	Description
`int`

COST_PER_TRAVELED_HOUR_FIELD_NUMBER

public static final int COST_PER_TRAVELED_HOUR_FIELD_NUMBER

Field Value

Type	Description
`int`

END_LOAD_INTERVALS_FIELD_NUMBER

public static final int END_LOAD_INTERVALS_FIELD_NUMBER

Field Value

Type	Description
`int`

END_LOCATION_FIELD_NUMBER

public static final int END_LOCATION_FIELD_NUMBER

Field Value

Type	Description
`int`

END_TAGS_FIELD_NUMBER

public static final int END_TAGS_FIELD_NUMBER

Field Value

Type	Description
`int`

END_TIME_WINDOWS_FIELD_NUMBER

public static final int END_TIME_WINDOWS_FIELD_NUMBER

Field Value

Type	Description
`int`

END_WAYPOINT_FIELD_NUMBER

public static final int END_WAYPOINT_FIELD_NUMBER

Field Value

Type	Description
`int`

EXTRA_VISIT_DURATION_FOR_VISIT_TYPE_FIELD_NUMBER

public static final int EXTRA_VISIT_DURATION_FOR_VISIT_TYPE_FIELD_NUMBER

Field Value

Type	Description
`int`

FIXED_COST_FIELD_NUMBER

public static final int FIXED_COST_FIELD_NUMBER

Field Value

Type	Description
`int`

IGNORE_FIELD_NUMBER

public static final int IGNORE_FIELD_NUMBER

Field Value

Type	Description
`int`

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER

Field Value

Type	Description
`int`

LOAD_LIMITS_FIELD_NUMBER

public static final int LOAD_LIMITS_FIELD_NUMBER

Field Value

Type	Description
`int`

ROUTE_DISTANCE_LIMIT_FIELD_NUMBER

public static final int ROUTE_DISTANCE_LIMIT_FIELD_NUMBER

Field Value

Type	Description
`int`

ROUTE_DURATION_LIMIT_FIELD_NUMBER

public static final int ROUTE_DURATION_LIMIT_FIELD_NUMBER

Field Value

Type	Description
`int`

START_LOAD_INTERVALS_FIELD_NUMBER

public static final int START_LOAD_INTERVALS_FIELD_NUMBER

Field Value

Type	Description
`int`

START_LOCATION_FIELD_NUMBER

public static final int START_LOCATION_FIELD_NUMBER

Field Value

Type	Description
`int`

START_TAGS_FIELD_NUMBER

public static final int START_TAGS_FIELD_NUMBER

Field Value

Type	Description
`int`

START_TIME_WINDOWS_FIELD_NUMBER

public static final int START_TIME_WINDOWS_FIELD_NUMBER

Field Value

Type	Description
`int`

START_WAYPOINT_FIELD_NUMBER

public static final int START_WAYPOINT_FIELD_NUMBER

Field Value

Type	Description
`int`

TRAVEL_DURATION_LIMIT_FIELD_NUMBER

public static final int TRAVEL_DURATION_LIMIT_FIELD_NUMBER

Field Value

Type	Description
`int`

TRAVEL_DURATION_MULTIPLE_FIELD_NUMBER

public static final int TRAVEL_DURATION_MULTIPLE_FIELD_NUMBER

Field Value

Type	Description
`int`

TRAVEL_MODE_FIELD_NUMBER

public static final int TRAVEL_MODE_FIELD_NUMBER

Field Value

Type	Description
`int`

UNLOADING_POLICY_FIELD_NUMBER

public static final int UNLOADING_POLICY_FIELD_NUMBER

Field Value

Type	Description
`int`

USED_IF_ROUTE_IS_EMPTY_FIELD_NUMBER

public static final int USED_IF_ROUTE_IS_EMPTY_FIELD_NUMBER

Field Value

Type	Description
`int`

Static Methods

getDefaultInstance()

public static Vehicle getDefaultInstance()

Returns

Type	Description
`Vehicle`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
`Descriptor`

newBuilder()

public static Vehicle.Builder newBuilder()

Returns

Type	Description
`Vehicle.Builder`

newBuilder(Vehicle prototype)

public static Vehicle.Builder newBuilder(Vehicle prototype)

Parameter

Name	Description
`prototype`	`Vehicle`

Returns

Type	Description
`Vehicle.Builder`

parseDelimitedFrom(InputStream input)

public static Vehicle parseDelimitedFrom(InputStream input)

Parameter

Name	Description
`input`	`InputStream`

Returns

Type	Description
`Vehicle`

Exceptions

Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Vehicle parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Vehicle`

Exceptions

Type	Description
`IOException`

parseFrom(byte[] data)

public static Vehicle parseFrom(byte[] data)

Parameter

Name	Description
`data`	`byte[]`

Returns

Type	Description
`Vehicle`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Vehicle parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Vehicle`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Vehicle parseFrom(ByteString data)

Parameter

Name	Description
`data`	`ByteString`

Returns

Type	Description
`Vehicle`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Vehicle parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Vehicle`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Vehicle parseFrom(CodedInputStream input)

Parameter

Name	Description
`input`	`CodedInputStream`

Returns

Type	Description
`Vehicle`

Exceptions

Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Vehicle parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Vehicle`

Exceptions

Type	Description
`IOException`

parseFrom(InputStream input)

public static Vehicle parseFrom(InputStream input)

Parameter

Name	Description
`input`	`InputStream`

Returns

Type	Description
`Vehicle`

Exceptions

Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Vehicle parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Vehicle`

Exceptions

Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Vehicle parseFrom(ByteBuffer data)

Parameter

Name	Description
`data`	`ByteBuffer`

Returns

Type	Description
`Vehicle`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Vehicle parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`Vehicle`

Exceptions

Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Vehicle> parser()

Returns

Type	Description
`Parser<Vehicle>`

Methods

containsExtraVisitDurationForVisitType(String key)

public boolean containsExtraVisitDurationForVisitType(String key)

Specifies a map from visit_types strings to durations. The duration is time in addition to VisitRequest.duration to be taken at visits with the specified visit_types. This extra visit duration adds cost if cost_per_hour is specified. Keys (i.e. visit_types) cannot be empty strings. If a visit request has multiple types, a duration will be added for each type in the map.

map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`boolean`

containsLoadLimits(String key)

public boolean containsLoadLimits(String key)

Capacities of the vehicle (weight, volume, # of pallets for example). The keys in the map are the identifiers of the type of load, consistent with the keys of the Shipment.load_demands field. If a given key is absent from this map, the corresponding capacity is considered to be limitless.

map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`boolean`

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
`obj`	`Object`

Returns

Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getBreakRule()

public BreakRule getBreakRule()

Describes the break schedule to be enforced on this vehicle. If empty, no breaks will be scheduled for this vehicle.

.google.cloud.optimization.v1.BreakRule break_rule = 25;

Returns

Type	Description
`BreakRule`	The breakRule.

getBreakRuleIndices(int index) (deprecated)

public int getBreakRuleIndices(int index)

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

Deprecated: No longer used. Indices in the break_rule field in the source ShipmentModel. They correspond to break rules enforced on the vehicle. As of 2018/03, at most one rule index per vehicle can be specified.

repeated int32 break_rule_indices = 29 [deprecated = true];

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`int`	The breakRuleIndices at the given index.

getBreakRuleIndicesCount() (deprecated)

public int getBreakRuleIndicesCount()

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

repeated int32 break_rule_indices = 29 [deprecated = true];

Returns

Type	Description
`int`	The count of breakRuleIndices.

getBreakRuleIndicesList() (deprecated)

public List<Integer> getBreakRuleIndicesList()

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

repeated int32 break_rule_indices = 29 [deprecated = true];

Returns

Type	Description
`List<Integer>`	A list containing the breakRuleIndices.

getBreakRuleOrBuilder()

public BreakRuleOrBuilder getBreakRuleOrBuilder()

Describes the break schedule to be enforced on this vehicle. If empty, no breaks will be scheduled for this vehicle.

.google.cloud.optimization.v1.BreakRule break_rule = 25;

Returns

Type	Description
`BreakRuleOrBuilder`

getCapacities(int index)

public CapacityQuantity getCapacities(int index)

Deprecated: Use Vehicle.load_limits instead.

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

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`CapacityQuantity`

getCapacitiesCount()

public int getCapacitiesCount()

Deprecated: Use Vehicle.load_limits instead.

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

Returns

Type	Description
`int`

getCapacitiesList()

public List<CapacityQuantity> getCapacitiesList()

Deprecated: Use Vehicle.load_limits instead.

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

Returns

Type	Description
`List<CapacityQuantity>`

getCapacitiesOrBuilder(int index)

public CapacityQuantityOrBuilder getCapacitiesOrBuilder(int index)

Deprecated: Use Vehicle.load_limits instead.

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

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`CapacityQuantityOrBuilder`

getCapacitiesOrBuilderList()

public List<? extends CapacityQuantityOrBuilder> getCapacitiesOrBuilderList()

Deprecated: Use Vehicle.load_limits instead.

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

Returns

Type	Description
`List<? extends com.google.cloud.optimization.v1.CapacityQuantityOrBuilder>`

getCostPerHour()

public double getCostPerHour()

Vehicle costs: all costs add up and must be in the same unit as Shipment.penalty_cost. Cost per hour of the vehicle route. This cost is applied to the total time taken by the route, and includes travel time, waiting time, and visit time. Using cost_per_hour instead of just cost_per_traveled_hour may result in additional latency.

double cost_per_hour = 16;

Returns

Type	Description
`double`	The costPerHour.

getCostPerKilometer()

public double getCostPerKilometer()

Cost per kilometer of the vehicle route. This cost is applied to the distance reported in the ShipmentRoute.transitions and does not apply to any distance implicitly traveled from the arrival_location to the departure_location of a single VisitRequest.

double cost_per_kilometer = 18;

Returns

Type	Description
`double`	The costPerKilometer.

getCostPerTraveledHour()

public double getCostPerTraveledHour()

Cost per traveled hour of the vehicle route. This cost is applied only to travel time taken by the route (i.e., that reported in ShipmentRoute.transitions), and excludes waiting time and visit time.

double cost_per_traveled_hour = 17;

Returns

Type	Description
`double`	The costPerTraveledHour.

getDefaultInstanceForType()

public Vehicle getDefaultInstanceForType()

Returns

Type	Description
`Vehicle`

getEndLoadIntervals(int index)

public CapacityQuantityInterval getEndLoadIntervals(int index)

Deprecated: Use Vehicle.LoadLimit.end_load_interval instead.

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

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`CapacityQuantityInterval`

getEndLoadIntervalsCount()

public int getEndLoadIntervalsCount()

Deprecated: Use Vehicle.LoadLimit.end_load_interval instead.

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

Returns

Type	Description
`int`

getEndLoadIntervalsList()

public List<CapacityQuantityInterval> getEndLoadIntervalsList()

Deprecated: Use Vehicle.LoadLimit.end_load_interval instead.

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

Returns

Type	Description
`List<CapacityQuantityInterval>`

getEndLoadIntervalsOrBuilder(int index)

public CapacityQuantityIntervalOrBuilder getEndLoadIntervalsOrBuilder(int index)

Deprecated: Use Vehicle.LoadLimit.end_load_interval instead.

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

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`CapacityQuantityIntervalOrBuilder`

getEndLoadIntervalsOrBuilderList()

public List<? extends CapacityQuantityIntervalOrBuilder> getEndLoadIntervalsOrBuilderList()

Deprecated: Use Vehicle.LoadLimit.end_load_interval instead.

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

Returns

Type	Description
`List<? extends com.google.cloud.optimization.v1.CapacityQuantityIntervalOrBuilder>`

getEndLocation()

public LatLng getEndLocation()

Geographic location where the vehicle ends after it has completed its last VisitRequest. If not specified the vehicle's ShipmentRoute ends immediately when it completes its last VisitRequest. If the shipment model has duration and distance matrices, end_location must not be specified.

.google.type.LatLng end_location = 5;

Returns

Type	Description
`com.google.type.LatLng`	The endLocation.

getEndLocationOrBuilder()

public LatLngOrBuilder getEndLocationOrBuilder()

.google.type.LatLng end_location = 5;

Returns

Type	Description
`com.google.type.LatLngOrBuilder`

getEndTags(int index)

public String getEndTags(int index)

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

repeated string end_tags = 8;

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`String`	The endTags at the given index.

getEndTagsBytes(int index)

public ByteString getEndTagsBytes(int index)

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

repeated string end_tags = 8;

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`ByteString`	The bytes of the endTags at the given index.

getEndTagsCount()

public int getEndTagsCount()

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

repeated string end_tags = 8;

Returns

Type	Description
`int`	The count of endTags.

getEndTagsList()

public ProtocolStringList getEndTagsList()

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

repeated string end_tags = 8;

Returns

Type	Description
`ProtocolStringList`	A list containing the endTags.

getEndTimeWindows(int index)

public TimeWindow getEndTimeWindows(int index)

Time windows during which the vehicle may arrive at its end location. They must be within the global time limits (see ShipmentModel.global_* fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`TimeWindow`

getEndTimeWindowsCount()

public int getEndTimeWindowsCount()

repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;

Returns

Type	Description
`int`

getEndTimeWindowsList()

public List<TimeWindow> getEndTimeWindowsList()

repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;

Returns

Type	Description
`List<TimeWindow>`

getEndTimeWindowsOrBuilder(int index)

public TimeWindowOrBuilder getEndTimeWindowsOrBuilder(int index)

repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`TimeWindowOrBuilder`

getEndTimeWindowsOrBuilderList()

public List<? extends TimeWindowOrBuilder> getEndTimeWindowsOrBuilderList()

repeated .google.cloud.optimization.v1.TimeWindow end_time_windows = 10;

Returns

Type	Description
`List<? extends com.google.cloud.optimization.v1.TimeWindowOrBuilder>`

getEndWaypoint()

public Waypoint getEndWaypoint()

Waypoint representing a geographic location where the vehicle ends after it has completed its last VisitRequest. If neither end_waypoint nor end_location is specified, the vehicle's ShipmentRoute ends immediately when it completes its last VisitRequest. If the shipment model has duration and distance matrices, end_waypoint must not be specified.

.google.cloud.optimization.v1.Waypoint end_waypoint = 6;

Returns

Type	Description
`Waypoint`	The endWaypoint.

getEndWaypointOrBuilder()

public WaypointOrBuilder getEndWaypointOrBuilder()

.google.cloud.optimization.v1.Waypoint end_waypoint = 6;

Returns

Type	Description
`WaypointOrBuilder`

getExtraVisitDurationForVisitType()

public Map<String,Duration> getExtraVisitDurationForVisitType()

Use #getExtraVisitDurationForVisitTypeMap() instead.

Returns

Type	Description
`Map<String,Duration>`

getExtraVisitDurationForVisitTypeCount()

public int getExtraVisitDurationForVisitTypeCount()

map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;

Returns

Type	Description
`int`

getExtraVisitDurationForVisitTypeMap()

public Map<String,Duration> getExtraVisitDurationForVisitTypeMap()

map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;

Returns

Type	Description
`Map<String,Duration>`

getExtraVisitDurationForVisitTypeOrDefault(String key, Duration defaultValue)

public Duration getExtraVisitDurationForVisitTypeOrDefault(String key, Duration defaultValue)

map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;

Parameters

Name	Description
`key`	`String`
`defaultValue`	`Duration`

Returns

Type	Description
`Duration`

getExtraVisitDurationForVisitTypeOrThrow(String key)

public Duration getExtraVisitDurationForVisitTypeOrThrow(String key)

map<string, .google.protobuf.Duration> extra_visit_duration_for_visit_type = 24;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`Duration`

getFixedCost()

public double getFixedCost()

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

double fixed_cost = 19;

Returns

Type	Description
`double`	The fixedCost.

getIgnore()

public boolean getIgnore()

If true, used_if_route_is_empty must be false, and this vehicle will remain unused. If a shipment is performed by an ignored vehicle in injected_first_solution_routes, it is skipped in the first solution but is free to be performed in the response. If a shipment is performed by an ignored vehicle in injected_solution_constraint and any related pickup/delivery is constrained to remain on the vehicle (i.e., not relaxed to level RELAX_ALL_AFTER_THRESHOLD), it is skipped in the response. If a shipment has a non-empty allowed_vehicle_indices field and all of the allowed vehicles are ignored, it is skipped in the response.

bool ignore = 28;

Returns

Type	Description
`boolean`	The ignore.

getLabel()

public String getLabel()

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

string label = 27;

Returns

Type	Description
`String`	The label.

getLabelBytes()

public ByteString getLabelBytes()

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

string label = 27;

Returns

Type	Description
`ByteString`	The bytes for label.

getLoadLimits()

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

Use #getLoadLimitsMap() instead.

Returns

Type	Description
`Map<String,LoadLimit>`

getLoadLimitsCount()

public int getLoadLimitsCount()

map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;

Returns

Type	Description
`int`

getLoadLimitsMap()

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

map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;

Returns

Type	Description
`Map<String,LoadLimit>`

getLoadLimitsOrDefault(String key, Vehicle.LoadLimit defaultValue)

public Vehicle.LoadLimit getLoadLimitsOrDefault(String key, Vehicle.LoadLimit defaultValue)

map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;

Parameters

Name	Description
`key`	`String`
`defaultValue`	`Vehicle.LoadLimit`

Returns

Type	Description
`Vehicle.LoadLimit`

getLoadLimitsOrThrow(String key)

public Vehicle.LoadLimit getLoadLimitsOrThrow(String key)

map<string, .google.cloud.optimization.v1.Vehicle.LoadLimit> load_limits = 30;

Parameter

Name	Description
`key`	`String`

Returns

Type	Description
`Vehicle.LoadLimit`

getParserForType()

public Parser<Vehicle> getParserForType()

Returns

Type	Description
`Parser<Vehicle>`

Overrides

GeneratedMessageV3.getParserForType()

getRouteDistanceLimit()

public DistanceLimit getRouteDistanceLimit()

Limit applied to the total distance of the vehicle's route. In a given OptimizeToursResponse, the route distance is the sum of all its transitions.travel_distance_meters.

.google.cloud.optimization.v1.DistanceLimit route_distance_limit = 23;

Returns

Type	Description
`DistanceLimit`	The routeDistanceLimit.

getRouteDistanceLimitOrBuilder()

public DistanceLimitOrBuilder getRouteDistanceLimitOrBuilder()

Limit applied to the total distance of the vehicle's route. In a given OptimizeToursResponse, the route distance is the sum of all its transitions.travel_distance_meters.

.google.cloud.optimization.v1.DistanceLimit route_distance_limit = 23;

Returns

Type	Description
`DistanceLimitOrBuilder`

getRouteDurationLimit()

public Vehicle.DurationLimit getRouteDurationLimit()

Limit applied to the total duration of the vehicle's route. In a given OptimizeToursResponse, the route duration of a vehicle is the difference between its vehicle_end_time and vehicle_start_time.

.google.cloud.optimization.v1.Vehicle.DurationLimit route_duration_limit = 21;

Returns

Type	Description
`Vehicle.DurationLimit`	The routeDurationLimit.

getRouteDurationLimitOrBuilder()

public Vehicle.DurationLimitOrBuilder getRouteDurationLimitOrBuilder()

.google.cloud.optimization.v1.Vehicle.DurationLimit route_duration_limit = 21;

Returns

Type	Description
`Vehicle.DurationLimitOrBuilder`

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getStartLoadIntervals(int index)

public CapacityQuantityInterval getStartLoadIntervals(int index)

Deprecated: Use Vehicle.LoadLimit.start_load_interval instead.

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

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`CapacityQuantityInterval`

getStartLoadIntervalsCount()

public int getStartLoadIntervalsCount()

Deprecated: Use Vehicle.LoadLimit.start_load_interval instead.

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

Returns

Type	Description
`int`

getStartLoadIntervalsList()

public List<CapacityQuantityInterval> getStartLoadIntervalsList()

Deprecated: Use Vehicle.LoadLimit.start_load_interval instead.

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

Returns

Type	Description
`List<CapacityQuantityInterval>`

getStartLoadIntervalsOrBuilder(int index)

public CapacityQuantityIntervalOrBuilder getStartLoadIntervalsOrBuilder(int index)

Deprecated: Use Vehicle.LoadLimit.start_load_interval instead.

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

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`CapacityQuantityIntervalOrBuilder`

getStartLoadIntervalsOrBuilderList()

public List<? extends CapacityQuantityIntervalOrBuilder> getStartLoadIntervalsOrBuilderList()

Deprecated: Use Vehicle.LoadLimit.start_load_interval instead.

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

Returns

Type	Description
`List<? extends com.google.cloud.optimization.v1.CapacityQuantityIntervalOrBuilder>`

getStartLocation()

public LatLng getStartLocation()

Geographic location where the vehicle starts before picking up any shipments. If not specified, the vehicle starts at its first pickup. If the shipment model has duration and distance matrices, start_location must not be specified.

.google.type.LatLng start_location = 3;

Returns

Type	Description
`com.google.type.LatLng`	The startLocation.

getStartLocationOrBuilder()

public LatLngOrBuilder getStartLocationOrBuilder()

.google.type.LatLng start_location = 3;

Returns

Type	Description
`com.google.type.LatLngOrBuilder`

getStartTags(int index)

public String getStartTags(int index)

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

repeated string start_tags = 7;

Parameter

Name	Description
`index`	`int` The index of the element to return.

Returns

Type	Description
`String`	The startTags at the given index.

getStartTagsBytes(int index)

public ByteString getStartTagsBytes(int index)

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

repeated string start_tags = 7;

Parameter

Name	Description
`index`	`int` The index of the value to return.

Returns

Type	Description
`ByteString`	The bytes of the startTags at the given index.

getStartTagsCount()

public int getStartTagsCount()

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

repeated string start_tags = 7;

Returns

Type	Description
`int`	The count of startTags.

getStartTagsList()

public ProtocolStringList getStartTagsList()

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

repeated string start_tags = 7;

Returns

Type	Description
`ProtocolStringList`	A list containing the startTags.

getStartTimeWindows(int index)

public TimeWindow getStartTimeWindows(int index)

Time windows during which the vehicle may depart its start location. They must be within the global time limits (see ShipmentModel.global_* fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`TimeWindow`

getStartTimeWindowsCount()

public int getStartTimeWindowsCount()

repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;

Returns

Type	Description
`int`

getStartTimeWindowsList()

public List<TimeWindow> getStartTimeWindowsList()

repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;

Returns

Type	Description
`List<TimeWindow>`

getStartTimeWindowsOrBuilder(int index)

public TimeWindowOrBuilder getStartTimeWindowsOrBuilder(int index)

repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;

Parameter

Name	Description
`index`	`int`

Returns

Type	Description
`TimeWindowOrBuilder`

getStartTimeWindowsOrBuilderList()

public List<? extends TimeWindowOrBuilder> getStartTimeWindowsOrBuilderList()

repeated .google.cloud.optimization.v1.TimeWindow start_time_windows = 9;

Returns

Type	Description
`List<? extends com.google.cloud.optimization.v1.TimeWindowOrBuilder>`

getStartWaypoint()

public Waypoint getStartWaypoint()

Waypoint representing a geographic location where the vehicle starts before picking up any shipments. If neither start_waypoint nor start_location is specified, the vehicle starts at its first pickup. If the shipment model has duration and distance matrices, start_waypoint must not be specified.

.google.cloud.optimization.v1.Waypoint start_waypoint = 4;

Returns

Type	Description
`Waypoint`	The startWaypoint.

getStartWaypointOrBuilder()

public WaypointOrBuilder getStartWaypointOrBuilder()

.google.cloud.optimization.v1.Waypoint start_waypoint = 4;

Returns

Type	Description
`WaypointOrBuilder`

getTravelDurationLimit()

public Vehicle.DurationLimit getTravelDurationLimit()

Limit applied to the travel duration of the vehicle's route. In a given OptimizeToursResponse, the route travel duration is the sum of all its transitions.travel_duration.

.google.cloud.optimization.v1.Vehicle.DurationLimit travel_duration_limit = 22;

Returns

Type	Description
`Vehicle.DurationLimit`	The travelDurationLimit.

getTravelDurationLimitOrBuilder()

public Vehicle.DurationLimitOrBuilder getTravelDurationLimitOrBuilder()

Limit applied to the travel duration of the vehicle's route. In a given OptimizeToursResponse, the route travel duration is the sum of all its transitions.travel_duration.

.google.cloud.optimization.v1.Vehicle.DurationLimit travel_duration_limit = 22;

Returns

Type	Description
`Vehicle.DurationLimitOrBuilder`

getTravelDurationMultiple()

public double getTravelDurationMultiple()

Specifies a multiplicative factor that can be used to increase or decrease travel times of this vehicle. For example, setting this to 2.0 means that this vehicle is slower and has travel times that are twice what they are for standard vehicles. This multiple does not affect visit durations. It does affect cost if cost_per_hour or cost_per_traveled_hour are specified. This must be in the range [0.001, 1000.0]. If unset, the vehicle is standard, and this multiple is considered 1.0. WARNING: Travel times will be rounded to the nearest second after this multiple is applied but before performing any numerical operations, thus, a small multiple may result in a loss of precision. See also extra_visit_duration_for_visit_type below.

optional double travel_duration_multiple = 11;

Returns

Type	Description
`double`	The travelDurationMultiple.

getTravelMode()

public Vehicle.TravelMode getTravelMode()

The travel mode which affects the roads usable by the vehicle and its speed. See also travel_duration_multiple.

.google.cloud.optimization.v1.Vehicle.TravelMode travel_mode = 1;

Returns

Type	Description
`Vehicle.TravelMode`	The travelMode.

getTravelModeValue()

public int getTravelModeValue()

The travel mode which affects the roads usable by the vehicle and its speed. See also travel_duration_multiple.

.google.cloud.optimization.v1.Vehicle.TravelMode travel_mode = 1;

Returns

Type	Description
`int`	The enum numeric value on the wire for travelMode.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
`UnknownFieldSet`

Overrides

GeneratedMessageV3.getUnknownFields()

getUnloadingPolicy()

public Vehicle.UnloadingPolicy getUnloadingPolicy()

Unloading policy enforced on the vehicle.

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

Returns

Type	Description
`Vehicle.UnloadingPolicy`	The unloadingPolicy.

getUnloadingPolicyValue()

public int getUnloadingPolicyValue()

Unloading policy enforced on the vehicle.

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

Returns

Type	Description
`int`	The enum numeric value on the wire for unloadingPolicy.

getUsedIfRouteIsEmpty()

public boolean getUsedIfRouteIsEmpty()

This field only applies to vehicles when their route does not serve any shipments. It indicates if the vehicle should be considered as used or not in this case. If true, the vehicle goes from its start to its end location even if it doesn't serve any shipments, and time and distance costs resulting from its start --> end travel are taken into account. Otherwise, it doesn't travel from its start to its end location, and no break_rule or delay (from TransitionAttributes) are scheduled for this vehicle. In this case, the vehicle's ShipmentRoute doesn't contain any information except for the vehicle index and label.

bool used_if_route_is_empty = 20;

Returns

Type	Description
`boolean`	The usedIfRouteIsEmpty.

hasBreakRule()

public boolean hasBreakRule()

Describes the break schedule to be enforced on this vehicle. If empty, no breaks will be scheduled for this vehicle.

.google.cloud.optimization.v1.BreakRule break_rule = 25;

Returns

Type	Description
`boolean`	Whether the breakRule field is set.

hasEndLocation()

public boolean hasEndLocation()

.google.type.LatLng end_location = 5;

Returns

Type	Description
`boolean`	Whether the endLocation field is set.

hasEndWaypoint()

public boolean hasEndWaypoint()

.google.cloud.optimization.v1.Waypoint end_waypoint = 6;

Returns

Type	Description
`boolean`	Whether the endWaypoint field is set.

hasRouteDistanceLimit()

public boolean hasRouteDistanceLimit()

Limit applied to the total distance of the vehicle's route. In a given OptimizeToursResponse, the route distance is the sum of all its transitions.travel_distance_meters.

.google.cloud.optimization.v1.DistanceLimit route_distance_limit = 23;

Returns

Type	Description
`boolean`	Whether the routeDistanceLimit field is set.

hasRouteDurationLimit()

public boolean hasRouteDurationLimit()

.google.cloud.optimization.v1.Vehicle.DurationLimit route_duration_limit = 21;

Returns

Type	Description
`boolean`	Whether the routeDurationLimit field is set.

hasStartLocation()

public boolean hasStartLocation()

.google.type.LatLng start_location = 3;

Returns

Type	Description
`boolean`	Whether the startLocation field is set.

hasStartWaypoint()

public boolean hasStartWaypoint()

.google.cloud.optimization.v1.Waypoint start_waypoint = 4;

Returns

Type	Description
`boolean`	Whether the startWaypoint field is set.

hasTravelDurationLimit()

public boolean hasTravelDurationLimit()

Limit applied to the travel duration of the vehicle's route. In a given OptimizeToursResponse, the route travel duration is the sum of all its transitions.travel_duration.

.google.cloud.optimization.v1.Vehicle.DurationLimit travel_duration_limit = 22;

Returns

Type	Description
`boolean`	Whether the travelDurationLimit field is set.

hasTravelDurationMultiple()

public boolean hasTravelDurationMultiple()

optional double travel_duration_multiple = 11;

Returns

Type	Description
`boolean`	Whether the travelDurationMultiple field is set.

hashCode()

public int hashCode()

Returns

Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
`number`	`int`

Returns

Type	Description
`MapField`

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Vehicle.Builder newBuilderForType()

Returns

Type	Description
`Vehicle.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Vehicle.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
`parent`	`BuilderParent`

Returns

Type	Description
`Vehicle.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
`unused`	`UnusedPrivateParameter`

Returns

Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Vehicle.Builder toBuilder()

Returns

Type	Description
`Vehicle.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
`IOException`