public static final class ShipmentRoute.Visit extends GeneratedMessageV3 implements ShipmentRoute.VisitOrBuilder
A visit performed during a route. This visit corresponds to a pickup or a
delivery of a Shipment.
Protobuf type google.cloud.optimization.v1.ShipmentRoute.Visit
Static Fields
ARRIVAL_LOADS_FIELD_NUMBER
public static final int ARRIVAL_LOADS_FIELD_NUMBER
Field Value
DELAY_BEFORE_START_FIELD_NUMBER
public static final int DELAY_BEFORE_START_FIELD_NUMBER
Field Value
DEMANDS_FIELD_NUMBER
public static final int DEMANDS_FIELD_NUMBER
Field Value
DETOUR_FIELD_NUMBER
public static final int DETOUR_FIELD_NUMBER
Field Value
IS_PICKUP_FIELD_NUMBER
public static final int IS_PICKUP_FIELD_NUMBER
Field Value
LOAD_DEMANDS_FIELD_NUMBER
public static final int LOAD_DEMANDS_FIELD_NUMBER
Field Value
SHIPMENT_INDEX_FIELD_NUMBER
public static final int SHIPMENT_INDEX_FIELD_NUMBER
Field Value
SHIPMENT_LABEL_FIELD_NUMBER
public static final int SHIPMENT_LABEL_FIELD_NUMBER
Field Value
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
Field Value
VISIT_LABEL_FIELD_NUMBER
public static final int VISIT_LABEL_FIELD_NUMBER
Field Value
VISIT_REQUEST_INDEX_FIELD_NUMBER
public static final int VISIT_REQUEST_INDEX_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ShipmentRoute.Visit getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ShipmentRoute.Visit.Builder newBuilder()
Returns
newBuilder(ShipmentRoute.Visit prototype)
public static ShipmentRoute.Visit.Builder newBuilder(ShipmentRoute.Visit prototype)
Parameter
Returns
public static ShipmentRoute.Visit parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ShipmentRoute.Visit parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ShipmentRoute.Visit parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ShipmentRoute.Visit parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ShipmentRoute.Visit parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ShipmentRoute.Visit parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ShipmentRoute.Visit parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ShipmentRoute.Visit parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ShipmentRoute.Visit parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ShipmentRoute.Visit parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ShipmentRoute.Visit parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ShipmentRoute.Visit parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ShipmentRoute.Visit> parser()
Returns
Methods
containsLoadDemands(String key)
public boolean containsLoadDemands(String key)
Total visit load demand as the sum of the shipment and the visit request
load_demands. The values are negative if the visit is a delivery.
Demands are reported for the same types as the
Transition.loads
(see this field).
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 11;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getArrivalLoads(int index)
public CapacityQuantity getArrivalLoads(int index)
Deprecated: Use [ShipmentRoute.Transition.loads][] instead.
Vehicle loads upon arrival at the visit location, for each
type specified in Vehicle.capacities, start_load_intervals,
end_load_intervals or demands.
Exception: we omit loads for quantity types unconstrained by intervals
and that don't have any non-zero demand on the route.
repeated .google.cloud.optimization.v1.CapacityQuantity arrival_loads = 9 [deprecated = true];
getArrivalLoadsCount()
public int getArrivalLoadsCount()
Deprecated: Use [ShipmentRoute.Transition.loads][] instead.
Vehicle loads upon arrival at the visit location, for each
type specified in Vehicle.capacities, start_load_intervals,
end_load_intervals or demands.
Exception: we omit loads for quantity types unconstrained by intervals
and that don't have any non-zero demand on the route.
repeated .google.cloud.optimization.v1.CapacityQuantity arrival_loads = 9 [deprecated = true];
getArrivalLoadsList()
public List<CapacityQuantity> getArrivalLoadsList()
Deprecated: Use [ShipmentRoute.Transition.loads][] instead.
Vehicle loads upon arrival at the visit location, for each
type specified in Vehicle.capacities, start_load_intervals,
end_load_intervals or demands.
Exception: we omit loads for quantity types unconstrained by intervals
and that don't have any non-zero demand on the route.
repeated .google.cloud.optimization.v1.CapacityQuantity arrival_loads = 9 [deprecated = true];
getArrivalLoadsOrBuilder(int index)
public CapacityQuantityOrBuilder getArrivalLoadsOrBuilder(int index)
Deprecated: Use [ShipmentRoute.Transition.loads][] instead.
Vehicle loads upon arrival at the visit location, for each
type specified in Vehicle.capacities, start_load_intervals,
end_load_intervals or demands.
Exception: we omit loads for quantity types unconstrained by intervals
and that don't have any non-zero demand on the route.
repeated .google.cloud.optimization.v1.CapacityQuantity arrival_loads = 9 [deprecated = true];
getArrivalLoadsOrBuilderList()
public List<? extends CapacityQuantityOrBuilder> getArrivalLoadsOrBuilderList()
Deprecated: Use [ShipmentRoute.Transition.loads][] instead.
Vehicle loads upon arrival at the visit location, for each
type specified in Vehicle.capacities, start_load_intervals,
end_load_intervals or demands.
Exception: we omit loads for quantity types unconstrained by intervals
and that don't have any non-zero demand on the route.
repeated .google.cloud.optimization.v1.CapacityQuantity arrival_loads = 9 [deprecated = true];
| Type | Description |
| List<? extends com.google.cloud.optimization.v1.CapacityQuantityOrBuilder> | |
getDefaultInstanceForType()
public ShipmentRoute.Visit getDefaultInstanceForType()
Returns
getDelayBeforeStart()
public ShipmentRoute.Delay getDelayBeforeStart()
Deprecated: Use [ShipmentRoute.Transition.delay_duration][] instead.
.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_start = 10 [deprecated = true];
getDelayBeforeStartOrBuilder()
public ShipmentRoute.DelayOrBuilder getDelayBeforeStartOrBuilder()
Deprecated: Use [ShipmentRoute.Transition.delay_duration][] instead.
.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_start = 10 [deprecated = true];
getDemands(int index)
public CapacityQuantity getDemands(int index)
Deprecated: Use [Visit.load_demands][] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 5 [deprecated = true];
getDemandsCount()
public int getDemandsCount()
Deprecated: Use [Visit.load_demands][] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 5 [deprecated = true];
getDemandsList()
public List<CapacityQuantity> getDemandsList()
Deprecated: Use [Visit.load_demands][] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 5 [deprecated = true];
getDemandsOrBuilder(int index)
public CapacityQuantityOrBuilder getDemandsOrBuilder(int index)
Deprecated: Use [Visit.load_demands][] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 5 [deprecated = true];
getDemandsOrBuilderList()
public List<? extends CapacityQuantityOrBuilder> getDemandsOrBuilderList()
Deprecated: Use [Visit.load_demands][] instead.
repeated .google.cloud.optimization.v1.CapacityQuantity demands = 5 [deprecated = true];
| Type | Description |
| List<? extends com.google.cloud.optimization.v1.CapacityQuantityOrBuilder> | |
getDetour()
public Duration getDetour()
Extra detour time due to the shipments visited on the route before the
visit and to the potential waiting time induced by time windows.
If the visit is a delivery, the detour is computed from the corresponding
pickup visit and is equal to:
`
start_time(delivery) - start_time(pickup)
- (duration(pickup) + travel duration from the pickup location
to the delivery location).
Otherwise, it is computed from the vehicle start_location
and is equal
to:
start_time - vehicle_start_time - travel duration from
the vehicle's start_location to the visit.
`
.google.protobuf.Duration detour = 6;
getDetourOrBuilder()
public DurationOrBuilder getDetourOrBuilder()
Extra detour time due to the shipments visited on the route before the
visit and to the potential waiting time induced by time windows.
If the visit is a delivery, the detour is computed from the corresponding
pickup visit and is equal to:
`
start_time(delivery) - start_time(pickup)
- (duration(pickup) + travel duration from the pickup location
to the delivery location).
Otherwise, it is computed from the vehicle start_location
and is equal
to:
start_time - vehicle_start_time - travel duration from
the vehicle's start_location to the visit.
`
.google.protobuf.Duration detour = 6;
getIsPickup()
public boolean getIsPickup()
If true the visit corresponds to a pickup of a Shipment. Otherwise, it
corresponds to a delivery.
bool is_pickup = 2;
| Type | Description |
| boolean | The isPickup.
|
getLoadDemands()
public Map<String,Shipment.Load> getLoadDemands()
Returns
getLoadDemandsCount()
public int getLoadDemandsCount()
Total visit load demand as the sum of the shipment and the visit request
load_demands. The values are negative if the visit is a delivery.
Demands are reported for the same types as the
Transition.loads
(see this field).
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 11;
getLoadDemandsMap()
public Map<String,Shipment.Load> getLoadDemandsMap()
Total visit load demand as the sum of the shipment and the visit request
load_demands. The values are negative if the visit is a delivery.
Demands are reported for the same types as the
Transition.loads
(see this field).
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 11;
getLoadDemandsOrDefault(String key, Shipment.Load defaultValue)
public Shipment.Load getLoadDemandsOrDefault(String key, Shipment.Load defaultValue)
Total visit load demand as the sum of the shipment and the visit request
load_demands. The values are negative if the visit is a delivery.
Demands are reported for the same types as the
Transition.loads
(see this field).
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 11;
getLoadDemandsOrThrow(String key)
public Shipment.Load getLoadDemandsOrThrow(String key)
Total visit load demand as the sum of the shipment and the visit request
load_demands. The values are negative if the visit is a delivery.
Demands are reported for the same types as the
Transition.loads
(see this field).
map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 11;
getParserForType()
public Parser<ShipmentRoute.Visit> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getShipmentIndex()
public int getShipmentIndex()
Index of the shipments field in the source ShipmentModel.
int32 shipment_index = 1;
| Type | Description |
| int | The shipmentIndex.
|
getShipmentLabel()
public String getShipmentLabel()
Copy of the corresponding Shipment.label, if specified in the
Shipment.
string shipment_label = 7;
| Type | Description |
| String | The shipmentLabel.
|
getShipmentLabelBytes()
public ByteString getShipmentLabelBytes()
Copy of the corresponding Shipment.label, if specified in the
Shipment.
string shipment_label = 7;
| Type | Description |
| ByteString | The bytes for shipmentLabel.
|
getStartTime()
public Timestamp getStartTime()
Time at which the visit starts. Note that the vehicle may arrive earlier
than this at the visit location. Times are consistent with the
ShipmentModel.
.google.protobuf.Timestamp start_time = 4;
getStartTimeOrBuilder()
public TimestampOrBuilder getStartTimeOrBuilder()
Time at which the visit starts. Note that the vehicle may arrive earlier
than this at the visit location. Times are consistent with the
ShipmentModel.
.google.protobuf.Timestamp start_time = 4;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getVisitLabel()
public String getVisitLabel()
Copy of the corresponding
VisitRequest.label,
if specified in the VisitRequest.
string visit_label = 8;
| Type | Description |
| String | The visitLabel.
|
getVisitLabelBytes()
public ByteString getVisitLabelBytes()
Copy of the corresponding
VisitRequest.label,
if specified in the VisitRequest.
string visit_label = 8;
| Type | Description |
| ByteString | The bytes for visitLabel.
|
getVisitRequestIndex()
public int getVisitRequestIndex()
Index of VisitRequest in either the pickup or delivery field of the
Shipment (see is_pickup).
int32 visit_request_index = 3;
| Type | Description |
| int | The visitRequestIndex.
|
hasDelayBeforeStart()
public boolean hasDelayBeforeStart()
Deprecated: Use [ShipmentRoute.Transition.delay_duration][] instead.
.google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_start = 10 [deprecated = true];
| Type | Description |
| boolean | Whether the delayBeforeStart field is set.
|
hasDetour()
public boolean hasDetour()
Extra detour time due to the shipments visited on the route before the
visit and to the potential waiting time induced by time windows.
If the visit is a delivery, the detour is computed from the corresponding
pickup visit and is equal to:
`
start_time(delivery) - start_time(pickup)
- (duration(pickup) + travel duration from the pickup location
to the delivery location).
Otherwise, it is computed from the vehicle start_location
and is equal
to:
start_time - vehicle_start_time - travel duration from
the vehicle's start_location to the visit.
`
.google.protobuf.Duration detour = 6;
| Type | Description |
| boolean | Whether the detour field is set.
|
hasStartTime()
public boolean hasStartTime()
Time at which the visit starts. Note that the vehicle may arrive earlier
than this at the visit location. Times are consistent with the
ShipmentModel.
.google.protobuf.Timestamp start_time = 4;
| Type | Description |
| boolean | Whether the startTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ShipmentRoute.Visit.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ShipmentRoute.Visit.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ShipmentRoute.Visit.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
