Class Shipment.VisitRequest (1.1.14)
Stay organized with collections
Save and categorize content based on your preferences.
- 1.76.0 (latest)
- 1.74.0
- 1.73.0
- 1.72.0
- 1.71.0
- 1.70.0
- 1.68.0
- 1.66.0
- 1.65.0
- 1.62.0
- 1.61.0
- 1.60.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.14
- 0.1.2
publicstaticfinalclass Shipment.VisitRequestextendsGeneratedMessageV3implementsShipment.VisitRequestOrBuilderRequest 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Shipment.VisitRequestImplements
Shipment.VisitRequestOrBuilderInherited Members
Static Fields
ARRIVAL_LOCATION_FIELD_NUMBER
publicstaticfinalintARRIVAL_LOCATION_FIELD_NUMBERARRIVAL_WAYPOINT_FIELD_NUMBER
publicstaticfinalintARRIVAL_WAYPOINT_FIELD_NUMBERCOST_FIELD_NUMBER
publicstaticfinalintCOST_FIELD_NUMBERDEMANDS_FIELD_NUMBER
publicstaticfinalintDEMANDS_FIELD_NUMBERDEPARTURE_LOCATION_FIELD_NUMBER
publicstaticfinalintDEPARTURE_LOCATION_FIELD_NUMBERDEPARTURE_WAYPOINT_FIELD_NUMBER
publicstaticfinalintDEPARTURE_WAYPOINT_FIELD_NUMBERDURATION_FIELD_NUMBER
publicstaticfinalintDURATION_FIELD_NUMBERLABEL_FIELD_NUMBER
publicstaticfinalintLABEL_FIELD_NUMBERLOAD_DEMANDS_FIELD_NUMBER
publicstaticfinalintLOAD_DEMANDS_FIELD_NUMBERTAGS_FIELD_NUMBER
publicstaticfinalintTAGS_FIELD_NUMBERTIME_WINDOWS_FIELD_NUMBER
publicstaticfinalintTIME_WINDOWS_FIELD_NUMBERVISIT_TYPES_FIELD_NUMBER
publicstaticfinalintVISIT_TYPES_FIELD_NUMBERStatic Methods
getDefaultInstance()
publicstaticShipment.VisitRequestgetDefaultInstance()getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()newBuilder()
publicstaticShipment.VisitRequest.BuildernewBuilder()newBuilder(Shipment.VisitRequest prototype)
publicstaticShipment.VisitRequest.BuildernewBuilder(Shipment.VisitRequestprototype)parseDelimitedFrom(InputStream input)
publicstaticShipment.VisitRequestparseDelimitedFrom(InputStreaminput)parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticShipment.VisitRequestparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(byte[] data)
publicstaticShipment.VisitRequestparseFrom(byte[]data)byte[]parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticShipment.VisitRequestparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)byte[]parseFrom(ByteString data)
publicstaticShipment.VisitRequestparseFrom(ByteStringdata)parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticShipment.VisitRequestparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)parseFrom(CodedInputStream input)
publicstaticShipment.VisitRequestparseFrom(CodedInputStreaminput)parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticShipment.VisitRequestparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(InputStream input)
publicstaticShipment.VisitRequestparseFrom(InputStreaminput)parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticShipment.VisitRequestparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)parseFrom(ByteBuffer data)
publicstaticShipment.VisitRequestparseFrom(ByteBufferdata)parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticShipment.VisitRequestparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)parser()
publicstaticParser<Shipment.VisitRequest>parser()Methods
containsLoadDemands(String key)
publicbooleancontainsLoadDemands(Stringkey)Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment. The demands listed here are added to the demands listed in Shipment.load_demands.
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;
equals(Object obj)
publicbooleanequals(Objectobj)getArrivalLocation()
publicLatLnggetArrivalLocation() 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;
The arrivalLocation.
getArrivalLocationOrBuilder()
publicLatLngOrBuildergetArrivalLocationOrBuilder() 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;
getArrivalWaypoint()
publicWaypointgetArrivalWaypoint() 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;
The arrivalWaypoint.
getArrivalWaypointOrBuilder()
publicWaypointOrBuildergetArrivalWaypointOrBuilder() 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;
getCost()
publicdoublegetCost() 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;
The cost.
getDefaultInstanceForType()
publicShipment.VisitRequestgetDefaultInstanceForType()getDemands(int index)
publicCapacityQuantitygetDemands(intindex)Deprecated: Use [VisitRequest.load_demands][] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
getDemandsCount()
publicintgetDemandsCount()Deprecated: Use [VisitRequest.load_demands][] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
getDemandsList()
publicList<CapacityQuantity>getDemandsList()Deprecated: Use [VisitRequest.load_demands][] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
getDemandsOrBuilder(int index)
publicCapacityQuantityOrBuildergetDemandsOrBuilder(intindex)Deprecated: Use [VisitRequest.load_demands][] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
getDemandsOrBuilderList()
publicList<?extendsCapacityQuantityOrBuilder>getDemandsOrBuilderList()Deprecated: Use [VisitRequest.load_demands][] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
getDepartureLocation()
publicLatLnggetDepartureLocation() 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;
The departureLocation.
getDepartureLocationOrBuilder()
publicLatLngOrBuildergetDepartureLocationOrBuilder() 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;
getDepartureWaypoint()
publicWaypointgetDepartureWaypoint() 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;
The departureWaypoint.
getDepartureWaypointOrBuilder()
publicWaypointOrBuildergetDepartureWaypointOrBuilder() 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;
getDuration()
publicDurationgetDuration() 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;
The duration.
getDurationOrBuilder()
publicDurationOrBuildergetDurationOrBuilder() 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;
getLabel()
publicStringgetLabel() Specifies a label for this VisitRequest. This label is reported in the
response as visit_label in the corresponding ShipmentRoute.Visit.
string label = 11;
The label.
getLabelBytes()
publicByteStringgetLabelBytes() Specifies a label for this VisitRequest. This label is reported in the
response as visit_label in the corresponding ShipmentRoute.Visit.
string label = 11;
The bytes for label.
getLoadDemands()
publicMap<String,Shipment.Load>getLoadDemands()Use #getLoadDemandsMap() instead.
getLoadDemandsCount()
publicintgetLoadDemandsCount()Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment. The demands listed here are added to the demands listed in Shipment.load_demands.
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;
getLoadDemandsMap()
publicMap<String,Shipment.Load>getLoadDemandsMap()Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment. The demands listed here are added to the demands listed in Shipment.load_demands.
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;
getLoadDemandsOrDefault(String key, Shipment.Load defaultValue)
publicShipment.LoadgetLoadDemandsOrDefault(Stringkey,Shipment.LoaddefaultValue)Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment. The demands listed here are added to the demands listed in Shipment.load_demands.
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;
getLoadDemandsOrThrow(String key)
publicShipment.LoadgetLoadDemandsOrThrow(Stringkey)Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment. The demands listed here are added to the demands listed in Shipment.load_demands.
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;
getParserForType()
publicParser<Shipment.VisitRequest>getParserForType()getSerializedSize()
publicintgetSerializedSize()getTags(int index)
publicStringgetTags(intindex)Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;
The tags at the given index.
getTagsBytes(int index)
publicByteStringgetTagsBytes(intindex)Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;
The bytes of the tags at the given index.
getTagsCount()
publicintgetTagsCount()Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;
The count of tags.
getTagsList()
publicProtocolStringListgetTagsList()Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;
A list containing the tags.
getTimeWindows(int index)
publicTimeWindowgetTimeWindows(intindex) 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.
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;
getTimeWindowsCount()
publicintgetTimeWindowsCount() 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.
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;
getTimeWindowsList()
publicList<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.
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;
getTimeWindowsOrBuilder(int index)
publicTimeWindowOrBuildergetTimeWindowsOrBuilder(intindex) 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.
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;
getTimeWindowsOrBuilderList()
publicList<?extendsTimeWindowOrBuilder>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.
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;
getUnknownFields()
publicfinalUnknownFieldSetgetUnknownFields()getVisitTypes(int index)
publicStringgetVisitTypes(intindex)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). A type can only appear once.
repeated string visit_types = 10;
The visitTypes at the given index.
getVisitTypesBytes(int index)
publicByteStringgetVisitTypesBytes(intindex)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). A type can only appear once.
repeated string visit_types = 10;
The bytes of the visitTypes at the given index.
getVisitTypesCount()
publicintgetVisitTypesCount()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). A type can only appear once.
repeated string visit_types = 10;
The count of visitTypes.
getVisitTypesList()
publicProtocolStringListgetVisitTypesList()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). A type can only appear once.
repeated string visit_types = 10;
A list containing the visitTypes.
hasArrivalLocation()
publicbooleanhasArrivalLocation() 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;
Whether the arrivalLocation field is set.
hasArrivalWaypoint()
publicbooleanhasArrivalWaypoint() 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;
Whether the arrivalWaypoint field is set.
hasDepartureLocation()
publicbooleanhasDepartureLocation() 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;
Whether the departureLocation field is set.
hasDepartureWaypoint()
publicbooleanhasDepartureWaypoint() 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;
Whether the departureWaypoint field is set.
hasDuration()
publicbooleanhasDuration() 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;
Whether the duration field is set.
hashCode()
publicinthashCode()internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()internalGetMapField(int number)
protectedMapFieldinternalGetMapField(intnumber)isInitialized()
publicfinalbooleanisInitialized()newBuilderForType()
publicShipment.VisitRequest.BuildernewBuilderForType()newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedShipment.VisitRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)toBuilder()
publicShipment.VisitRequest.BuildertoBuilder()writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)