Package com.google.cloud.optimization.v1
Class Shipment.VisitRequest
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.optimization.v1.Shipment.VisitRequest
-
- All Implemented Interfaces:
Shipment.VisitRequestOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
- Enclosing class:
- Shipment
public static final class Shipment.VisitRequest extends com.google.protobuf.GeneratedMessageV3 implements Shipment.VisitRequestOrBuilder
Request for a visit which can be done by a vehicle: it has a geo-location (or two, see below), opening and closing times represented by time windows, and a service duration time (time spent by the vehicle once it has arrived to pickup or drop off goods).
Protobuf typegoogle.cloud.optimization.v1.Shipment.VisitRequest- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classShipment.VisitRequest.BuilderRequest for a visit which can be done by a vehicle: it has a geo-location (or two, see below), opening and closing times represented by time windows, and a service duration time (time spent by the vehicle once it has arrived to pickup or drop off goods).-
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
Fields Modifier and Type Field Description static intARRIVAL_LOCATION_FIELD_NUMBERstatic intARRIVAL_WAYPOINT_FIELD_NUMBERstatic intCOST_FIELD_NUMBERstatic intDEMANDS_FIELD_NUMBERstatic intDEPARTURE_LOCATION_FIELD_NUMBERstatic intDEPARTURE_WAYPOINT_FIELD_NUMBERstatic intDURATION_FIELD_NUMBERstatic intLABEL_FIELD_NUMBERstatic intLOAD_DEMANDS_FIELD_NUMBERstatic intTAGS_FIELD_NUMBERstatic intTIME_WINDOWS_FIELD_NUMBERstatic intVISIT_TYPES_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleancontainsLoadDemands(String key)Load demands of this visit request.booleanequals(Object obj)com.google.type.LatLnggetArrivalLocation()The geo-location where the vehicle arrives when performing this `VisitRequest`.com.google.type.LatLngOrBuildergetArrivalLocationOrBuilder()The geo-location where the vehicle arrives when performing this `VisitRequest`.WaypointgetArrivalWaypoint()The waypoint where the vehicle arrives when performing this `VisitRequest`.WaypointOrBuildergetArrivalWaypointOrBuilder()The waypoint where the vehicle arrives when performing this `VisitRequest`.doublegetCost()Cost to service this visit request on a vehicle route.static Shipment.VisitRequestgetDefaultInstance()Shipment.VisitRequestgetDefaultInstanceForType()CapacityQuantitygetDemands(int index)Deprecated.intgetDemandsCount()Deprecated.List<CapacityQuantity>getDemandsList()Deprecated.CapacityQuantityOrBuildergetDemandsOrBuilder(int index)Deprecated.List<? extends CapacityQuantityOrBuilder>getDemandsOrBuilderList()Deprecated.com.google.type.LatLnggetDepartureLocation()The geo-location where the vehicle departs after completing this `VisitRequest`.com.google.type.LatLngOrBuildergetDepartureLocationOrBuilder()The geo-location where the vehicle departs after completing this `VisitRequest`.WaypointgetDepartureWaypoint()The waypoint where the vehicle departs after completing this `VisitRequest`.WaypointOrBuildergetDepartureWaypointOrBuilder()The waypoint where the vehicle departs after completing this `VisitRequest`.static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.DurationgetDuration()Duration of the visit, i.e.com.google.protobuf.DurationOrBuildergetDurationOrBuilder()Duration of the visit, i.e.StringgetLabel()Specifies a label for this `VisitRequest`.com.google.protobuf.ByteStringgetLabelBytes()Specifies a label for this `VisitRequest`.Map<String,Shipment.Load>getLoadDemands()Deprecated.intgetLoadDemandsCount()Load demands of this visit request.Map<String,Shipment.Load>getLoadDemandsMap()Load demands of this visit request.Shipment.LoadgetLoadDemandsOrDefault(String key, Shipment.Load defaultValue)Load demands of this visit request.Shipment.LoadgetLoadDemandsOrThrow(String key)Load demands of this visit request.com.google.protobuf.Parser<Shipment.VisitRequest>getParserForType()intgetSerializedSize()StringgetTags(int index)Specifies tags attached to the visit request.com.google.protobuf.ByteStringgetTagsBytes(int index)Specifies tags attached to the visit request.intgetTagsCount()Specifies tags attached to the visit request.com.google.protobuf.ProtocolStringListgetTagsList()Specifies tags attached to the visit request.TimeWindowgetTimeWindows(int index)Time windows which constrain the arrival time at a visit.intgetTimeWindowsCount()Time windows which constrain the arrival time at a visit.List<TimeWindow>getTimeWindowsList()Time windows which constrain the arrival time at a visit.TimeWindowOrBuildergetTimeWindowsOrBuilder(int index)Time windows which constrain the arrival time at a visit.List<? extends TimeWindowOrBuilder>getTimeWindowsOrBuilderList()Time windows which constrain the arrival time at a visit.StringgetVisitTypes(int index)Specifies the types of the visit.com.google.protobuf.ByteStringgetVisitTypesBytes(int index)Specifies the types of the visit.intgetVisitTypesCount()Specifies the types of the visit.com.google.protobuf.ProtocolStringListgetVisitTypesList()Specifies the types of the visit.booleanhasArrivalLocation()The geo-location where the vehicle arrives when performing this `VisitRequest`.booleanhasArrivalWaypoint()The waypoint where the vehicle arrives when performing this `VisitRequest`.booleanhasDepartureLocation()The geo-location where the vehicle departs after completing this `VisitRequest`.booleanhasDepartureWaypoint()The waypoint where the vehicle departs after completing this `VisitRequest`.booleanhasDuration()Duration of the visit, i.e.inthashCode()protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)booleanisInitialized()static Shipment.VisitRequest.BuildernewBuilder()static Shipment.VisitRequest.BuildernewBuilder(Shipment.VisitRequest prototype)Shipment.VisitRequest.BuildernewBuilderForType()protected Shipment.VisitRequest.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static Shipment.VisitRequestparseDelimitedFrom(InputStream input)static Shipment.VisitRequestparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Shipment.VisitRequestparseFrom(byte[] data)static Shipment.VisitRequestparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Shipment.VisitRequestparseFrom(com.google.protobuf.ByteString data)static Shipment.VisitRequestparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Shipment.VisitRequestparseFrom(com.google.protobuf.CodedInputStream input)static Shipment.VisitRequestparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Shipment.VisitRequestparseFrom(InputStream input)static Shipment.VisitRequestparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static Shipment.VisitRequestparseFrom(ByteBuffer data)static Shipment.VisitRequestparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<Shipment.VisitRequest>parser()Shipment.VisitRequest.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
ARRIVAL_LOCATION_FIELD_NUMBER
public static final int ARRIVAL_LOCATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ARRIVAL_WAYPOINT_FIELD_NUMBER
public static final int ARRIVAL_WAYPOINT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DEPARTURE_LOCATION_FIELD_NUMBER
public static final int DEPARTURE_LOCATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DEPARTURE_WAYPOINT_FIELD_NUMBER
public static final int DEPARTURE_WAYPOINT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TAGS_FIELD_NUMBER
public static final int TAGS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TIME_WINDOWS_FIELD_NUMBER
public static final int TIME_WINDOWS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DURATION_FIELD_NUMBER
public static final int DURATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
COST_FIELD_NUMBER
public static final int COST_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LOAD_DEMANDS_FIELD_NUMBER
public static final int LOAD_DEMANDS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
VISIT_TYPES_FIELD_NUMBER
public static final int VISIT_TYPES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LABEL_FIELD_NUMBER
public static final int LABEL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DEMANDS_FIELD_NUMBER
public static final int DEMANDS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
hasArrivalLocation
public boolean hasArrivalLocation()
The geo-location where the vehicle arrives when performing this `VisitRequest`. If the shipment model has duration distance matrices, `arrival_location` must not be specified.
.google.type.LatLng arrival_location = 1;- Specified by:
hasArrivalLocationin interfaceShipment.VisitRequestOrBuilder- Returns:
- Whether the arrivalLocation field is set.
-
getArrivalLocation
public com.google.type.LatLng getArrivalLocation()
The geo-location where the vehicle arrives when performing this `VisitRequest`. If the shipment model has duration distance matrices, `arrival_location` must not be specified.
.google.type.LatLng arrival_location = 1;- Specified by:
getArrivalLocationin interfaceShipment.VisitRequestOrBuilder- Returns:
- The arrivalLocation.
-
getArrivalLocationOrBuilder
public com.google.type.LatLngOrBuilder getArrivalLocationOrBuilder()
The geo-location where the vehicle arrives when performing this `VisitRequest`. If the shipment model has duration distance matrices, `arrival_location` must not be specified.
.google.type.LatLng arrival_location = 1;- Specified by:
getArrivalLocationOrBuilderin interfaceShipment.VisitRequestOrBuilder
-
hasArrivalWaypoint
public boolean hasArrivalWaypoint()
The waypoint where the vehicle arrives when performing this `VisitRequest`. If the shipment model has duration distance matrices, `arrival_waypoint` must not be specified.
.google.cloud.optimization.v1.Waypoint arrival_waypoint = 2;- Specified by:
hasArrivalWaypointin interfaceShipment.VisitRequestOrBuilder- Returns:
- Whether the arrivalWaypoint field is set.
-
getArrivalWaypoint
public Waypoint getArrivalWaypoint()
The waypoint where the vehicle arrives when performing this `VisitRequest`. If the shipment model has duration distance matrices, `arrival_waypoint` must not be specified.
.google.cloud.optimization.v1.Waypoint arrival_waypoint = 2;- Specified by:
getArrivalWaypointin interfaceShipment.VisitRequestOrBuilder- Returns:
- The arrivalWaypoint.
-
getArrivalWaypointOrBuilder
public WaypointOrBuilder getArrivalWaypointOrBuilder()
The waypoint where the vehicle arrives when performing this `VisitRequest`. If the shipment model has duration distance matrices, `arrival_waypoint` must not be specified.
.google.cloud.optimization.v1.Waypoint arrival_waypoint = 2;- Specified by:
getArrivalWaypointOrBuilderin interfaceShipment.VisitRequestOrBuilder
-
hasDepartureLocation
public boolean hasDepartureLocation()
The geo-location where the vehicle departs after completing this `VisitRequest`. Can be omitted if it is the same as `arrival_location`. If the shipment model has duration distance matrices, `departure_location` must not be specified.
.google.type.LatLng departure_location = 3;- Specified by:
hasDepartureLocationin interfaceShipment.VisitRequestOrBuilder- Returns:
- Whether the departureLocation field is set.
-
getDepartureLocation
public com.google.type.LatLng getDepartureLocation()
The geo-location where the vehicle departs after completing this `VisitRequest`. Can be omitted if it is the same as `arrival_location`. If the shipment model has duration distance matrices, `departure_location` must not be specified.
.google.type.LatLng departure_location = 3;- Specified by:
getDepartureLocationin interfaceShipment.VisitRequestOrBuilder- Returns:
- The departureLocation.
-
getDepartureLocationOrBuilder
public com.google.type.LatLngOrBuilder getDepartureLocationOrBuilder()
The geo-location where the vehicle departs after completing this `VisitRequest`. Can be omitted if it is the same as `arrival_location`. If the shipment model has duration distance matrices, `departure_location` must not be specified.
.google.type.LatLng departure_location = 3;- Specified by:
getDepartureLocationOrBuilderin interfaceShipment.VisitRequestOrBuilder
-
hasDepartureWaypoint
public boolean hasDepartureWaypoint()
The waypoint where the vehicle departs after completing this `VisitRequest`. Can be omitted if it is the same as `arrival_waypoint`. If the shipment model has duration distance matrices, `departure_waypoint` must not be specified.
.google.cloud.optimization.v1.Waypoint departure_waypoint = 4;- Specified by:
hasDepartureWaypointin interfaceShipment.VisitRequestOrBuilder- Returns:
- Whether the departureWaypoint field is set.
-
getDepartureWaypoint
public Waypoint getDepartureWaypoint()
The waypoint where the vehicle departs after completing this `VisitRequest`. Can be omitted if it is the same as `arrival_waypoint`. If the shipment model has duration distance matrices, `departure_waypoint` must not be specified.
.google.cloud.optimization.v1.Waypoint departure_waypoint = 4;- Specified by:
getDepartureWaypointin interfaceShipment.VisitRequestOrBuilder- Returns:
- The departureWaypoint.
-
getDepartureWaypointOrBuilder
public WaypointOrBuilder getDepartureWaypointOrBuilder()
The waypoint where the vehicle departs after completing this `VisitRequest`. Can be omitted if it is the same as `arrival_waypoint`. If the shipment model has duration distance matrices, `departure_waypoint` must not be specified.
.google.cloud.optimization.v1.Waypoint departure_waypoint = 4;- Specified by:
getDepartureWaypointOrBuilderin interfaceShipment.VisitRequestOrBuilder
-
getTagsList
public com.google.protobuf.ProtocolStringList getTagsList()
Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;- Specified by:
getTagsListin interfaceShipment.VisitRequestOrBuilder- Returns:
- A list containing the tags.
-
getTagsCount
public int getTagsCount()
Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;- Specified by:
getTagsCountin interfaceShipment.VisitRequestOrBuilder- Returns:
- The count of tags.
-
getTags
public String getTags(int index)
Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;- Specified by:
getTagsin interfaceShipment.VisitRequestOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The tags at the given index.
-
getTagsBytes
public com.google.protobuf.ByteString getTagsBytes(int index)
Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;- Specified by:
getTagsBytesin interfaceShipment.VisitRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the tags at the given index.
-
getTimeWindowsList
public List<TimeWindow> getTimeWindowsList()
Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before [TimeWindow.start_time][google.cloud.optimization.v1.TimeWindow.start_time]. The absence of `TimeWindow` means that the vehicle can perform this visit at any time. Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing 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 time_windows = 6;- Specified by:
getTimeWindowsListin interfaceShipment.VisitRequestOrBuilder
-
getTimeWindowsOrBuilderList
public List<? extends TimeWindowOrBuilder> getTimeWindowsOrBuilderList()
Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before [TimeWindow.start_time][google.cloud.optimization.v1.TimeWindow.start_time]. The absence of `TimeWindow` means that the vehicle can perform this visit at any time. Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing 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 time_windows = 6;- Specified by:
getTimeWindowsOrBuilderListin interfaceShipment.VisitRequestOrBuilder
-
getTimeWindowsCount
public int getTimeWindowsCount()
Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before [TimeWindow.start_time][google.cloud.optimization.v1.TimeWindow.start_time]. The absence of `TimeWindow` means that the vehicle can perform this visit at any time. Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing 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 time_windows = 6;- Specified by:
getTimeWindowsCountin interfaceShipment.VisitRequestOrBuilder
-
getTimeWindows
public TimeWindow getTimeWindows(int index)
Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before [TimeWindow.start_time][google.cloud.optimization.v1.TimeWindow.start_time]. The absence of `TimeWindow` means that the vehicle can perform this visit at any time. Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing 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 time_windows = 6;- Specified by:
getTimeWindowsin interfaceShipment.VisitRequestOrBuilder
-
getTimeWindowsOrBuilder
public TimeWindowOrBuilder getTimeWindowsOrBuilder(int index)
Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before [TimeWindow.start_time][google.cloud.optimization.v1.TimeWindow.start_time]. The absence of `TimeWindow` means that the vehicle can perform this visit at any time. Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing 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 time_windows = 6;- Specified by:
getTimeWindowsOrBuilderin interfaceShipment.VisitRequestOrBuilder
-
hasDuration
public boolean hasDuration()
Duration of the visit, i.e. time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see `time_windows`).
.google.protobuf.Duration duration = 7;- Specified by:
hasDurationin interfaceShipment.VisitRequestOrBuilder- Returns:
- Whether the duration field is set.
-
getDuration
public com.google.protobuf.Duration getDuration()
Duration of the visit, i.e. time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see `time_windows`).
.google.protobuf.Duration duration = 7;- Specified by:
getDurationin interfaceShipment.VisitRequestOrBuilder- Returns:
- The duration.
-
getDurationOrBuilder
public com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
Duration of the visit, i.e. time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see `time_windows`).
.google.protobuf.Duration duration = 7;- Specified by:
getDurationOrBuilderin interfaceShipment.VisitRequestOrBuilder
-
getCost
public double getCost()
Cost to service this visit request on a vehicle route. This can be used to pay different costs for each alternative pickup or delivery of a shipment. This cost must be in the same unit as `Shipment.penalty_cost` and must not be negative.
double cost = 8;- Specified by:
getCostin interfaceShipment.VisitRequestOrBuilder- Returns:
- The cost.
-
getLoadDemandsCount
public int getLoadDemandsCount()
Description copied from interface:Shipment.VisitRequestOrBuilderLoad demands of this visit request. This is just like [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] field, except that it only applies to this [VisitRequest][google.cloud.optimization.v1.Shipment.VisitRequest] instead of the whole [Shipment][google.cloud.optimization.v1.Shipment]. The demands listed here are added to the demands listed in [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands].
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;- Specified by:
getLoadDemandsCountin interfaceShipment.VisitRequestOrBuilder
-
containsLoadDemands
public boolean containsLoadDemands(String key)
Load demands of this visit request. This is just like [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] field, except that it only applies to this [VisitRequest][google.cloud.optimization.v1.Shipment.VisitRequest] instead of the whole [Shipment][google.cloud.optimization.v1.Shipment]. The demands listed here are added to the demands listed in [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands].
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;- Specified by:
containsLoadDemandsin interfaceShipment.VisitRequestOrBuilder
-
getLoadDemands
@Deprecated public Map<String,Shipment.Load> getLoadDemands()
Deprecated.UsegetLoadDemandsMap()instead.- Specified by:
getLoadDemandsin interfaceShipment.VisitRequestOrBuilder
-
getLoadDemandsMap
public Map<String,Shipment.Load> getLoadDemandsMap()
Load demands of this visit request. This is just like [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] field, except that it only applies to this [VisitRequest][google.cloud.optimization.v1.Shipment.VisitRequest] instead of the whole [Shipment][google.cloud.optimization.v1.Shipment]. The demands listed here are added to the demands listed in [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands].
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;- Specified by:
getLoadDemandsMapin interfaceShipment.VisitRequestOrBuilder
-
getLoadDemandsOrDefault
public Shipment.Load getLoadDemandsOrDefault(String key, Shipment.Load defaultValue)
Load demands of this visit request. This is just like [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] field, except that it only applies to this [VisitRequest][google.cloud.optimization.v1.Shipment.VisitRequest] instead of the whole [Shipment][google.cloud.optimization.v1.Shipment]. The demands listed here are added to the demands listed in [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands].
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;- Specified by:
getLoadDemandsOrDefaultin interfaceShipment.VisitRequestOrBuilder
-
getLoadDemandsOrThrow
public Shipment.Load getLoadDemandsOrThrow(String key)
Load demands of this visit request. This is just like [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands] field, except that it only applies to this [VisitRequest][google.cloud.optimization.v1.Shipment.VisitRequest] instead of the whole [Shipment][google.cloud.optimization.v1.Shipment]. The demands listed here are added to the demands listed in [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands].
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;- Specified by:
getLoadDemandsOrThrowin interfaceShipment.VisitRequestOrBuilder
-
getVisitTypesList
public com.google.protobuf.ProtocolStringList getVisitTypesList()
Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see [Vehicle.extra_visit_duration_for_visit_type][google.cloud.optimization.v1.Vehicle.extra_visit_duration_for_visit_type]). A type can only appear once.
repeated string visit_types = 10;- Specified by:
getVisitTypesListin interfaceShipment.VisitRequestOrBuilder- Returns:
- A list containing the visitTypes.
-
getVisitTypesCount
public int getVisitTypesCount()
Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see [Vehicle.extra_visit_duration_for_visit_type][google.cloud.optimization.v1.Vehicle.extra_visit_duration_for_visit_type]). A type can only appear once.
repeated string visit_types = 10;- Specified by:
getVisitTypesCountin interfaceShipment.VisitRequestOrBuilder- Returns:
- The count of visitTypes.
-
getVisitTypes
public String getVisitTypes(int index)
Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see [Vehicle.extra_visit_duration_for_visit_type][google.cloud.optimization.v1.Vehicle.extra_visit_duration_for_visit_type]). A type can only appear once.
repeated string visit_types = 10;- Specified by:
getVisitTypesin interfaceShipment.VisitRequestOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The visitTypes at the given index.
-
getVisitTypesBytes
public com.google.protobuf.ByteString getVisitTypesBytes(int index)
Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see [Vehicle.extra_visit_duration_for_visit_type][google.cloud.optimization.v1.Vehicle.extra_visit_duration_for_visit_type]). A type can only appear once.
repeated string visit_types = 10;- Specified by:
getVisitTypesBytesin interfaceShipment.VisitRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the visitTypes at the given index.
-
getLabel
public String getLabel()
Specifies a label for this `VisitRequest`. This label is reported in the response as `visit_label` in the corresponding [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit].
string label = 11;- Specified by:
getLabelin interfaceShipment.VisitRequestOrBuilder- Returns:
- The label.
-
getLabelBytes
public com.google.protobuf.ByteString getLabelBytes()
Specifies a label for this `VisitRequest`. This label is reported in the response as `visit_label` in the corresponding [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit].
string label = 11;- Specified by:
getLabelBytesin interfaceShipment.VisitRequestOrBuilder- Returns:
- The bytes for label.
-
getDemandsList
@Deprecated public List<CapacityQuantity> getDemandsList()
Deprecated.Deprecated: Use [VisitRequest.load_demands][google.cloud.optimization.v1.Shipment.VisitRequest.load_demands] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];- Specified by:
getDemandsListin interfaceShipment.VisitRequestOrBuilder
-
getDemandsOrBuilderList
@Deprecated public List<? extends CapacityQuantityOrBuilder> getDemandsOrBuilderList()
Deprecated.Deprecated: Use [VisitRequest.load_demands][google.cloud.optimization.v1.Shipment.VisitRequest.load_demands] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];- Specified by:
getDemandsOrBuilderListin interfaceShipment.VisitRequestOrBuilder
-
getDemandsCount
@Deprecated public int getDemandsCount()
Deprecated.Deprecated: Use [VisitRequest.load_demands][google.cloud.optimization.v1.Shipment.VisitRequest.load_demands] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];- Specified by:
getDemandsCountin interfaceShipment.VisitRequestOrBuilder
-
getDemands
@Deprecated public CapacityQuantity getDemands(int index)
Deprecated.Deprecated: Use [VisitRequest.load_demands][google.cloud.optimization.v1.Shipment.VisitRequest.load_demands] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];- Specified by:
getDemandsin interfaceShipment.VisitRequestOrBuilder
-
getDemandsOrBuilder
@Deprecated public CapacityQuantityOrBuilder getDemandsOrBuilder(int index)
Deprecated.Deprecated: Use [VisitRequest.load_demands][google.cloud.optimization.v1.Shipment.VisitRequest.load_demands] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];- Specified by:
getDemandsOrBuilderin interfaceShipment.VisitRequestOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Shipment.VisitRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Shipment.VisitRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Shipment.VisitRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Shipment.VisitRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Shipment.VisitRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Shipment.VisitRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Shipment.VisitRequest parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Shipment.VisitRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Shipment.VisitRequest parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Shipment.VisitRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static Shipment.VisitRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Shipment.VisitRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public Shipment.VisitRequest.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Shipment.VisitRequest.Builder newBuilder()
-
newBuilder
public static Shipment.VisitRequest.Builder newBuilder(Shipment.VisitRequest prototype)
-
toBuilder
public Shipment.VisitRequest.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Shipment.VisitRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static Shipment.VisitRequest getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Shipment.VisitRequest> parser()
-
getParserForType
public com.google.protobuf.Parser<Shipment.VisitRequest> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Shipment.VisitRequest getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-