Package com.google.cloud.optimization.v1
Class Shipment.VisitRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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.GeneratedMessage
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 type
google.cloud.optimization.v1.Shipment.VisitRequest- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classRequest 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.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanLoad demands of this visit request.booleanThe geo-location where the vehicle arrives when performing this `VisitRequest`.The geo-location where the vehicle arrives when performing this `VisitRequest`.The waypoint where the vehicle arrives when performing this `VisitRequest`.The waypoint where the vehicle arrives when performing this `VisitRequest`.doublegetCost()Cost to service this visit request on a vehicle route.static Shipment.VisitRequestgetDemands(int index) Deprecated.intDeprecated.Deprecated.getDemandsOrBuilder(int index) Deprecated.List<? extends CapacityQuantityOrBuilder>Deprecated.The geo-location where the vehicle departs after completing this `VisitRequest`.The geo-location where the vehicle departs after completing this `VisitRequest`.The waypoint where the vehicle departs after completing this `VisitRequest`.The waypoint where the vehicle departs after completing this `VisitRequest`.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.DurationDuration 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`).com.google.protobuf.DurationOrBuilderDuration 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`).getLabel()Specifies a label for this `VisitRequest`.com.google.protobuf.ByteStringSpecifies a label for this `VisitRequest`.Deprecated.intLoad demands of this visit request.Load demands of this visit request.getLoadDemandsOrDefault(String key, Shipment.Load defaultValue) Load demands of this visit request.Load demands of this visit request.com.google.protobuf.Parser<Shipment.VisitRequest>intgetTags(int index) Specifies tags attached to the visit request.com.google.protobuf.ByteStringgetTagsBytes(int index) Specifies tags attached to the visit request.intSpecifies tags attached to the visit request.com.google.protobuf.ProtocolStringListSpecifies tags attached to the visit request.getTimeWindows(int index) Time windows which constrain the arrival time at a visit.intTime windows which constrain the arrival time at a visit.Time windows which constrain the arrival time at a visit.getTimeWindowsOrBuilder(int index) Time windows which constrain the arrival time at a visit.List<? extends TimeWindowOrBuilder>Time windows which constrain the arrival time at a visit.getVisitTypes(int index) Specifies the types of the visit.com.google.protobuf.ByteStringgetVisitTypesBytes(int index) Specifies the types of the visit.intSpecifies the types of the visit.com.google.protobuf.ProtocolStringListSpecifies the types of the visit.booleanThe geo-location where the vehicle arrives when performing this `VisitRequest`.booleanThe waypoint where the vehicle arrives when performing this `VisitRequest`.booleanThe geo-location where the vehicle departs after completing this `VisitRequest`.booleanThe waypoint where the vehicle departs after completing this `VisitRequest`.booleanDuration 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`).inthashCode()protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleannewBuilder(Shipment.VisitRequest prototype) protected Shipment.VisitRequest.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) 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()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
ARRIVAL_LOCATION_FIELD_NUMBER
public static final int ARRIVAL_LOCATION_FIELD_NUMBER- See Also:
-
ARRIVAL_WAYPOINT_FIELD_NUMBER
public static final int ARRIVAL_WAYPOINT_FIELD_NUMBER- See Also:
-
DEPARTURE_LOCATION_FIELD_NUMBER
public static final int DEPARTURE_LOCATION_FIELD_NUMBER- See Also:
-
DEPARTURE_WAYPOINT_FIELD_NUMBER
public static final int DEPARTURE_WAYPOINT_FIELD_NUMBER- See Also:
-
TAGS_FIELD_NUMBER
public static final int TAGS_FIELD_NUMBER- See Also:
-
TIME_WINDOWS_FIELD_NUMBER
public static final int TIME_WINDOWS_FIELD_NUMBER- See Also:
-
DURATION_FIELD_NUMBER
public static final int DURATION_FIELD_NUMBER- See Also:
-
COST_FIELD_NUMBER
public static final int COST_FIELD_NUMBER- See Also:
-
LOAD_DEMANDS_FIELD_NUMBER
public static final int LOAD_DEMANDS_FIELD_NUMBER- See Also:
-
VISIT_TYPES_FIELD_NUMBER
public static final int VISIT_TYPES_FIELD_NUMBER- See Also:
-
LABEL_FIELD_NUMBER
public static final int LABEL_FIELD_NUMBER- See Also:
-
DEMANDS_FIELD_NUMBER
public static final int DEMANDS_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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.UsegetLoadDemandsMap()instead.- Specified by:
getLoadDemandsin interfaceShipment.VisitRequestOrBuilder
-
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
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
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
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
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.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.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.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.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.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.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- 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
- Throws:
IOException
-
parseFrom
public static Shipment.VisitRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Shipment.VisitRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-