- 1.51.0 (latest)
- 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
public static interface Shipment.VisitRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLoadDemands(String key)
public abstract boolean containsLoadDemands(String key)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()
public abstract LatLng getArrivalLocation() The geo-location where the vehicle arrives when performing this
VisitRequest. If the shipment model has duration distance matrices,
arrival_location must not be specified.
.google.type.LatLng arrival_location = 1;
| Returns | |
|---|---|
| Type | Description |
com.google.type.LatLng | The arrivalLocation. |
getArrivalLocationOrBuilder()
public abstract LatLngOrBuilder getArrivalLocationOrBuilder() The geo-location where the vehicle arrives when performing this
VisitRequest. If the shipment model has duration distance matrices,
arrival_location must not be specified.
.google.type.LatLng arrival_location = 1;
| Returns | |
|---|---|
| Type | Description |
com.google.type.LatLngOrBuilder | |
getArrivalWaypoint()
public abstract Waypoint getArrivalWaypoint() The waypoint where the vehicle arrives when performing this
VisitRequest. If the shipment model has duration distance matrices,
arrival_waypoint must not be specified.
.google.cloud.optimization.v1.Waypoint arrival_waypoint = 2;
| Returns | |
|---|---|
| Type | Description |
Waypoint | The arrivalWaypoint. |
getArrivalWaypointOrBuilder()
public abstract WaypointOrBuilder getArrivalWaypointOrBuilder() The waypoint where the vehicle arrives when performing this
VisitRequest. If the shipment model has duration distance matrices,
arrival_waypoint must not be specified.
.google.cloud.optimization.v1.Waypoint arrival_waypoint = 2;
| Returns | |
|---|---|
| Type | Description |
WaypointOrBuilder | |
getCost()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
double | The cost. |
getDemands(int index)
public abstract CapacityQuantity getDemands(int index)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 | |
getDemandsCount()
public abstract int getDemandsCount()Deprecated: Use VisitRequest.load_demands instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
int | |
getDemandsList()
public abstract List<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)
public abstract CapacityQuantityOrBuilder getDemandsOrBuilder(int index)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()
public abstract List<? extends CapacityQuantityOrBuilder> 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()
public abstract LatLng getDepartureLocation() The geo-location where the vehicle departs after completing this
VisitRequest. Can be omitted if it is the same as arrival_location.
If the shipment model has duration distance matrices,
departure_location must not be specified.
.google.type.LatLng departure_location = 3;
| Returns | |
|---|---|
| Type | Description |
com.google.type.LatLng | The departureLocation. |
getDepartureLocationOrBuilder()
public abstract LatLngOrBuilder getDepartureLocationOrBuilder() The geo-location where the vehicle departs after completing this
VisitRequest. Can be omitted if it is the same as arrival_location.
If the shipment model has duration distance matrices,
departure_location must not be specified.
.google.type.LatLng departure_location = 3;
| Returns | |
|---|---|
| Type | Description |
com.google.type.LatLngOrBuilder | |
getDepartureWaypoint()
public abstract Waypoint getDepartureWaypoint() The waypoint where the vehicle departs after completing this
VisitRequest. Can be omitted if it is the same as arrival_waypoint.
If the shipment model has duration distance matrices,
departure_waypoint must not be specified.
.google.cloud.optimization.v1.Waypoint departure_waypoint = 4;
| Returns | |
|---|---|
| Type | Description |
Waypoint | The departureWaypoint. |
getDepartureWaypointOrBuilder()
public abstract WaypointOrBuilder getDepartureWaypointOrBuilder() The waypoint where the vehicle departs after completing this
VisitRequest. Can be omitted if it is the same as arrival_waypoint.
If the shipment model has duration distance matrices,
departure_waypoint must not be specified.
.google.cloud.optimization.v1.Waypoint departure_waypoint = 4;
| Returns | |
|---|---|
| Type | Description |
WaypointOrBuilder | |
getDuration()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
Duration | The duration. |
getDurationOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder | |
getLabel()
public abstract String getLabel() 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()
public abstract ByteString getLabelBytes() 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()
public abstract Map<String,Shipment.Load> getLoadDemands()Use #getLoadDemandsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Load> | |
getLoadDemandsCount()
public abstract int getLoadDemandsCount()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()
public abstract Map<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)
public abstract Shipment.Load getLoadDemandsOrDefault(String key, Shipment.Load defaultValue)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)
public abstract Shipment.Load getLoadDemandsOrThrow(String key)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 | |
getTags(int index)
public abstract String getTags(int index)Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The tags at the given index. |
getTagsBytes(int index)
public abstract ByteString getTagsBytes(int index)Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the tags at the given index. |
getTagsCount()
public abstract int getTagsCount()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()
public abstract List<String> getTagsList()Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.
repeated string tags = 5;
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the tags. |
getTimeWindows(int index)
public abstract TimeWindow getTimeWindows(int index) Time windows which constrain the arrival time at a visit.
Note that a vehicle may depart outside of the arrival time window, i.e.
arrival time + duration do not need to be inside a time window. This can
result in waiting time if the vehicle arrives before
TimeWindow.start_time.
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 | |
getTimeWindowsCount()
public abstract 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.
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()
public abstract List<TimeWindow> getTimeWindowsList() Time windows which constrain the arrival time at a visit.
Note that a vehicle may depart outside of the arrival time window, i.e.
arrival time + duration do not need to be inside a time window. This can
result in waiting time if the vehicle arrives before
TimeWindow.start_time.
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)
public abstract TimeWindowOrBuilder getTimeWindowsOrBuilder(int index) Time windows which constrain the arrival time at a visit.
Note that a vehicle may depart outside of the arrival time window, i.e.
arrival time + duration do not need to be inside a time window. This can
result in waiting time if the vehicle arrives before
TimeWindow.start_time.
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()
public abstract List<? extends TimeWindowOrBuilder> getTimeWindowsOrBuilderList() Time windows which constrain the arrival time at a visit.
Note that a vehicle may depart outside of the arrival time window, i.e.
arrival time + duration do not need to be inside a time window. This can
result in waiting time if the vehicle arrives before
TimeWindow.start_time.
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)
public abstract String getVisitTypes(int index)Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see Vehicle.extra_visit_duration_for_visit_type). A type can only appear once.
repeated string visit_types = 10;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The visitTypes at the given index. |
getVisitTypesBytes(int index)
public abstract 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). A type can only appear once.
repeated string visit_types = 10;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the visitTypes at the given index. |
getVisitTypesCount()
public abstract 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). A type can only appear once.
repeated string visit_types = 10;
| Returns | |
|---|---|
| Type | Description |
int | The count of visitTypes. |
getVisitTypesList()
public abstract List<String> 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). A type can only appear once.
repeated string visit_types = 10;
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the visitTypes. |
hasArrivalLocation()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the arrivalLocation field is set. |
hasArrivalWaypoint()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the arrivalWaypoint field is set. |
hasDepartureLocation()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the departureLocation field is set. |
hasDepartureWaypoint()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the departureWaypoint field is set. |
hasDuration()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the duration field is set. |