Class Shipment.VisitRequest.Builder (1.12.0)
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.VisitRequest.BuilderextendsGeneratedMessageV3.Builder<Shipment.VisitRequest.Builder>implementsShipment.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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Shipment.VisitRequest.BuilderImplements
Shipment.VisitRequestOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllDemands(Iterable<? extends CapacityQuantity> values)
publicShipment.VisitRequest.BuilderaddAllDemands(Iterable<?extendsCapacityQuantity>values)Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.optimization.v1.CapacityQuantity> |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
addAllTags(Iterable<String> values)
publicShipment.VisitRequest.BuilderaddAllTags(Iterable<String>values)Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The tags to add. |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |
addAllTimeWindows(Iterable<? extends TimeWindow> values)
publicShipment.VisitRequest.BuilderaddAllTimeWindows(Iterable<?extendsTimeWindow>values) 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;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.optimization.v1.TimeWindow> |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
addAllVisitTypes(Iterable<String> values)
publicShipment.VisitRequest.BuilderaddAllVisitTypes(Iterable<String>values)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;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The visitTypes to add. |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |
addDemands(CapacityQuantity value)
publicShipment.VisitRequest.BuilderaddDemands(CapacityQuantityvalue)Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
value |
CapacityQuantity |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
addDemands(CapacityQuantity.Builder builderForValue)
publicShipment.VisitRequest.BuilderaddDemands(CapacityQuantity.BuilderbuilderForValue)Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CapacityQuantity.Builder |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
addDemands(int index, CapacityQuantity value)
publicShipment.VisitRequest.BuilderaddDemands(intindex,CapacityQuantityvalue)Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CapacityQuantity |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
addDemands(int index, CapacityQuantity.Builder builderForValue)
publicShipment.VisitRequest.BuilderaddDemands(intindex,CapacityQuantity.BuilderbuilderForValue)Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CapacityQuantity.Builder |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
addDemandsBuilder()
publicCapacityQuantity.BuilderaddDemandsBuilder()Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
CapacityQuantity.Builder |
|
addDemandsBuilder(int index)
publicCapacityQuantity.BuilderaddDemandsBuilder(intindex)Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantity.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicShipment.VisitRequest.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
addTags(String value)
publicShipment.VisitRequest.BuilderaddTags(Stringvalue)Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
String The tags to add. |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |
addTagsBytes(ByteString value)
publicShipment.VisitRequest.BuilderaddTagsBytes(ByteStringvalue)Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes of the tags to add. |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |
addTimeWindows(TimeWindow value)
publicShipment.VisitRequest.BuilderaddTimeWindows(TimeWindowvalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
TimeWindow |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
addTimeWindows(TimeWindow.Builder builderForValue)
publicShipment.VisitRequest.BuilderaddTimeWindows(TimeWindow.BuilderbuilderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
TimeWindow.Builder |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
addTimeWindows(int index, TimeWindow value)
publicShipment.VisitRequest.BuilderaddTimeWindows(intindex,TimeWindowvalue) 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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
TimeWindow |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
addTimeWindows(int index, TimeWindow.Builder builderForValue)
publicShipment.VisitRequest.BuilderaddTimeWindows(intindex,TimeWindow.BuilderbuilderForValue) 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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
TimeWindow.Builder |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
addTimeWindowsBuilder()
publicTimeWindow.BuilderaddTimeWindowsBuilder() 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;
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
addTimeWindowsBuilder(int index)
publicTimeWindow.BuilderaddTimeWindowsBuilder(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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
addVisitTypes(String value)
publicShipment.VisitRequest.BuilderaddVisitTypes(Stringvalue)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;
| Parameter | |
|---|---|
| Name | Description |
value |
String The visitTypes to add. |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |
addVisitTypesBytes(ByteString value)
publicShipment.VisitRequest.BuilderaddVisitTypesBytes(ByteStringvalue)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes of the visitTypes to add. |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |
build()
publicShipment.VisitRequestbuild()| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest |
|
buildPartial()
publicShipment.VisitRequestbuildPartial()| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest |
|
clear()
publicShipment.VisitRequest.Builderclear()| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
clearArrivalLocation()
publicShipment.VisitRequest.BuilderclearArrivalLocation() 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;
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
clearArrivalWaypoint()
publicShipment.VisitRequest.BuilderclearArrivalWaypoint() 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;
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
clearCost()
publicShipment.VisitRequest.BuilderclearCost() 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;
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |
clearDemands()
publicShipment.VisitRequest.BuilderclearDemands()Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
clearDepartureLocation()
publicShipment.VisitRequest.BuilderclearDepartureLocation() 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;
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
clearDepartureWaypoint()
publicShipment.VisitRequest.BuilderclearDepartureWaypoint() 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;
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
clearDuration()
publicShipment.VisitRequest.BuilderclearDuration() 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;
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
publicShipment.VisitRequest.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
clearLabel()
publicShipment.VisitRequest.BuilderclearLabel() Specifies a label for this VisitRequest. This label is reported in the
response as visit_label in the corresponding
ShipmentRoute.Visit.
string label = 11;
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |
clearLoadDemands()
publicShipment.VisitRequest.BuilderclearLoadDemands()| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
publicShipment.VisitRequest.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
clearTags()
publicShipment.VisitRequest.BuilderclearTags()Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |
clearTimeWindows()
publicShipment.VisitRequest.BuilderclearTimeWindows() 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;
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
clearVisitTypes()
publicShipment.VisitRequest.BuilderclearVisitTypes()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;
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |
clone()
publicShipment.VisitRequest.Builderclone()| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
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;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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;
| Returns | |
|---|---|
| Type | Description |
com.google.type.LatLng |
The arrivalLocation. |
getArrivalLocationBuilder()
publicLatLng.BuildergetArrivalLocationBuilder() 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;
| Returns | |
|---|---|
| Type | Description |
com.google.type.LatLng.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
com.google.type.LatLngOrBuilder |
|
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;
| Returns | |
|---|---|
| Type | Description |
Waypoint |
The arrivalWaypoint. |
getArrivalWaypointBuilder()
publicWaypoint.BuildergetArrivalWaypointBuilder() 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;
| Returns | |
|---|---|
| Type | Description |
Waypoint.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
WaypointOrBuilder |
|
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;
| Returns | |
|---|---|
| Type | Description |
double |
The cost. |
getDefaultInstanceForType()
publicShipment.VisitRequestgetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest |
|
getDemands(int index)
publicCapacityQuantitygetDemands(intindex)Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantity |
|
getDemandsBuilder(int index)
publicCapacityQuantity.BuildergetDemandsBuilder(intindex)Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantity.Builder |
|
getDemandsBuilderList()
publicList<CapacityQuantity.Builder>getDemandsBuilderList()Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getDemandsCount()
publicintgetDemandsCount()Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
int |
|
getDemandsList()
publicList<CapacityQuantity>getDemandsList()Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
List<CapacityQuantity> |
|
getDemandsOrBuilder(int index)
publicCapacityQuantityOrBuildergetDemandsOrBuilder(intindex)Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CapacityQuantityOrBuilder |
|
getDemandsOrBuilderList()
publicList<?extendsCapacityQuantityOrBuilder>getDemandsOrBuilderList()Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.optimization.v1.CapacityQuantityOrBuilder> |
|
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;
| Returns | |
|---|---|
| Type | Description |
com.google.type.LatLng |
The departureLocation. |
getDepartureLocationBuilder()
publicLatLng.BuildergetDepartureLocationBuilder() 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;
| Returns | |
|---|---|
| Type | Description |
com.google.type.LatLng.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
com.google.type.LatLngOrBuilder |
|
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;
| Returns | |
|---|---|
| Type | Description |
Waypoint |
The departureWaypoint. |
getDepartureWaypointBuilder()
publicWaypoint.BuildergetDepartureWaypointBuilder() 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;
| Returns | |
|---|---|
| Type | Description |
Waypoint.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
WaypointOrBuilder |
|
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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;
| Returns | |
|---|---|
| Type | Description |
Duration |
The duration. |
getDurationBuilder()
publicDuration.BuildergetDurationBuilder() 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;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
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;
| Returns | |
|---|---|
| Type | Description |
String |
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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for label. |
getLoadDemands()
publicMap<String,Shipment.Load>getLoadDemands()Use #getLoadDemandsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Load> |
|
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;
| Returns | |
|---|---|
| Type | Description |
int |
|
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;
| Returns | |
|---|---|
| Type | Description |
Map<String,Load> |
|
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;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
Shipment.Load |
| Returns | |
|---|---|
| Type | Description |
Shipment.Load |
|
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;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
Shipment.Load |
|
getMutableLoadDemands()
publicMap<String,Shipment.Load>getMutableLoadDemands()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Load> |
|
getTags(int index)
publicStringgetTags(intindex)Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int The index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
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;
| Parameter | |
|---|---|
| Name | Description |
index |
int The index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
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;
| Returns | |
|---|---|
| Type | Description |
int |
The count of tags. |
getTagsList()
publicProtocolStringListgetTagsList()Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
TimeWindow |
|
getTimeWindowsBuilder(int index)
publicTimeWindow.BuildergetTimeWindowsBuilder(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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
getTimeWindowsBuilderList()
publicList<TimeWindow.Builder>getTimeWindowsBuilderList() 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;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
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;
| Returns | |
|---|---|
| Type | Description |
int |
|
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;
| Returns | |
|---|---|
| Type | Description |
List<TimeWindow> |
|
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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
TimeWindowOrBuilder |
|
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;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.optimization.v1.TimeWindowOrBuilder> |
|
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;
| Parameter | |
|---|---|
| Name | Description |
index |
int The index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
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;
| Parameter | |
|---|---|
| Name | Description |
index |
int The index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
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;
| Returns | |
|---|---|
| Type | Description |
int |
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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the duration field is set. |
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapField(int number)
protectedMapFieldinternalGetMapField(intnumber)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
MapField |
|
internalGetMutableMapField(int number)
protectedMapFieldinternalGetMutableMapField(intnumber)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
MapField |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeArrivalLocation(LatLng value)
publicShipment.VisitRequest.BuildermergeArrivalLocation(LatLngvalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.LatLng |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
mergeArrivalWaypoint(Waypoint value)
publicShipment.VisitRequest.BuildermergeArrivalWaypoint(Waypointvalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
Waypoint |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
mergeDepartureLocation(LatLng value)
publicShipment.VisitRequest.BuildermergeDepartureLocation(LatLngvalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.LatLng |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
mergeDepartureWaypoint(Waypoint value)
publicShipment.VisitRequest.BuildermergeDepartureWaypoint(Waypointvalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
Waypoint |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
mergeDuration(Duration value)
publicShipment.VisitRequest.BuildermergeDuration(Durationvalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
mergeFrom(Shipment.VisitRequest other)
publicShipment.VisitRequest.BuildermergeFrom(Shipment.VisitRequestother)| Parameter | |
|---|---|
| Name | Description |
other |
Shipment.VisitRequest |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicShipment.VisitRequest.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
publicShipment.VisitRequest.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalShipment.VisitRequest.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
putAllLoadDemands(Map<String,Shipment.Load> values)
publicShipment.VisitRequest.BuilderputAllLoadDemands(Map<String,Shipment.Load>values)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;
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,Load> |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
putLoadDemands(String key, Shipment.Load value)
publicShipment.VisitRequest.BuilderputLoadDemands(Stringkey,Shipment.Loadvalue)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;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
Shipment.Load |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
removeDemands(int index)
publicShipment.VisitRequest.BuilderremoveDemands(intindex)Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
removeLoadDemands(String key)
publicShipment.VisitRequest.BuilderremoveLoadDemands(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;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
removeTimeWindows(int index)
publicShipment.VisitRequest.BuilderremoveTimeWindows(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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setArrivalLocation(LatLng value)
publicShipment.VisitRequest.BuildersetArrivalLocation(LatLngvalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.LatLng |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setArrivalLocation(LatLng.Builder builderForValue)
publicShipment.VisitRequest.BuildersetArrivalLocation(LatLng.BuilderbuilderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.type.LatLng.Builder |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setArrivalWaypoint(Waypoint value)
publicShipment.VisitRequest.BuildersetArrivalWaypoint(Waypointvalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
Waypoint |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setArrivalWaypoint(Waypoint.Builder builderForValue)
publicShipment.VisitRequest.BuildersetArrivalWaypoint(Waypoint.BuilderbuilderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Waypoint.Builder |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setCost(double value)
publicShipment.VisitRequest.BuildersetCost(doublevalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
double The cost to set. |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |
setDemands(int index, CapacityQuantity value)
publicShipment.VisitRequest.BuildersetDemands(intindex,CapacityQuantityvalue)Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CapacityQuantity |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setDemands(int index, CapacityQuantity.Builder builderForValue)
publicShipment.VisitRequest.BuildersetDemands(intindex,CapacityQuantity.BuilderbuilderForValue)Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CapacityQuantity.Builder |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setDepartureLocation(LatLng value)
publicShipment.VisitRequest.BuildersetDepartureLocation(LatLngvalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.LatLng |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setDepartureLocation(LatLng.Builder builderForValue)
publicShipment.VisitRequest.BuildersetDepartureLocation(LatLng.BuilderbuilderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.type.LatLng.Builder |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setDepartureWaypoint(Waypoint value)
publicShipment.VisitRequest.BuildersetDepartureWaypoint(Waypointvalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
Waypoint |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setDepartureWaypoint(Waypoint.Builder builderForValue)
publicShipment.VisitRequest.BuildersetDepartureWaypoint(Waypoint.BuilderbuilderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Waypoint.Builder |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setDuration(Duration value)
publicShipment.VisitRequest.BuildersetDuration(Durationvalue) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setDuration(Duration.Builder builderForValue)
publicShipment.VisitRequest.BuildersetDuration(Duration.BuilderbuilderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
publicShipment.VisitRequest.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setLabel(String value)
publicShipment.VisitRequest.BuildersetLabel(Stringvalue) Specifies a label for this VisitRequest. This label is reported in the
response as visit_label in the corresponding
ShipmentRoute.Visit.
string label = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
String The label to set. |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |
setLabelBytes(ByteString value)
publicShipment.VisitRequest.BuildersetLabelBytes(ByteStringvalue) Specifies a label for this VisitRequest. This label is reported in the
response as visit_label in the corresponding
ShipmentRoute.Visit.
string label = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteString The bytes for label to set. |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicShipment.VisitRequest.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setTags(int index, String value)
publicShipment.VisitRequest.BuildersetTags(intindex,Stringvalue)Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int The index to set the value at. |
value |
String The tags to set. |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |
setTimeWindows(int index, TimeWindow value)
publicShipment.VisitRequest.BuildersetTimeWindows(intindex,TimeWindowvalue) 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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
TimeWindow |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setTimeWindows(int index, TimeWindow.Builder builderForValue)
publicShipment.VisitRequest.BuildersetTimeWindows(intindex,TimeWindow.BuilderbuilderForValue) 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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
TimeWindow.Builder |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalShipment.VisitRequest.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
|
setVisitTypes(int index, String value)
publicShipment.VisitRequest.BuildersetVisitTypes(intindex,Stringvalue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int The index to set the value at. |
value |
String The visitTypes to set. |
| Returns | |
|---|---|
| Type | Description |
Shipment.VisitRequest.Builder |
This builder for chaining. |