Package com.google.cloud.optimization.v1

Interface ShipmentRoute.VisitOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ShipmentRoute.Visit, ShipmentRoute.Visit.Builder
    Enclosing class:
    ShipmentRoute
    public static interface ShipmentRoute.VisitOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getShipmentIndex

        int getShipmentIndex()
         Index of the `shipments` field in the source
 [ShipmentModel][google.cloud.optimization.v1.ShipmentModel].
        int32 shipment_index = 1;
        Returns:
        The shipmentIndex.

      • getIsPickup

        boolean getIsPickup()
         If true the visit corresponds to a pickup of a `Shipment`. Otherwise, it
 corresponds to a delivery.
        bool is_pickup = 2;
        Returns:
        The isPickup.

      • getVisitRequestIndex

        int getVisitRequestIndex()
         Index of `VisitRequest` in either the pickup or delivery field of the
 `Shipment` (see `is_pickup`).
        int32 visit_request_index = 3;
        Returns:
        The visitRequestIndex.

      • hasStartTime

        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;
        Returns:
        Whether the startTime field is set.

      • getStartTime

        com.google.protobuf.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;
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        com.google.protobuf.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;

      • getLoadDemandsCount

        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][google.cloud.optimization.v1.ShipmentRoute.Transition]
 (see this field).
        map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 11;

      • containsLoadDemands

        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][google.cloud.optimization.v1.ShipmentRoute.Transition]
 (see this field).
        map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 11;

      • getLoadDemandsMap

        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][google.cloud.optimization.v1.ShipmentRoute.Transition]
 (see this field).
        map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 11;

      • getLoadDemandsOrDefault

        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][google.cloud.optimization.v1.ShipmentRoute.Transition]
 (see this field).
        map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 11;

      • getLoadDemandsOrThrow

        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][google.cloud.optimization.v1.ShipmentRoute.Transition]
 (see this field).
        map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 11;

      • hasDetour

        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;
        Returns:
        Whether the detour field is set.

      • getDetour

        com.google.protobuf.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;
        Returns:
        The detour.

      • getDetourOrBuilder

        com.google.protobuf.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;

      • getShipmentLabel

        String getShipmentLabel()
         Copy of the corresponding `Shipment.label`, if specified in the
 `Shipment`.
        string shipment_label = 7;
        Returns:
        The shipmentLabel.

      • getShipmentLabelBytes

        com.google.protobuf.ByteString getShipmentLabelBytes()
         Copy of the corresponding `Shipment.label`, if specified in the
 `Shipment`.
        string shipment_label = 7;
        Returns:
        The bytes for shipmentLabel.

      • getVisitLabel

        String getVisitLabel()
         Copy of the corresponding
 [VisitRequest.label][google.cloud.optimization.v1.Shipment.VisitRequest.label],
 if specified in the `VisitRequest`.
        string visit_label = 8;
        Returns:
        The visitLabel.

      • getVisitLabelBytes

        com.google.protobuf.ByteString getVisitLabelBytes()
         Copy of the corresponding
 [VisitRequest.label][google.cloud.optimization.v1.Shipment.VisitRequest.label],
 if specified in the `VisitRequest`.
        string visit_label = 8;
        Returns:
        The bytes for visitLabel.

      • getArrivalLoadsList

        @Deprecated
List<CapacityQuantity> getArrivalLoadsList()
        Deprecated.
         Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead. Vehicle loads upon arrival at the visit location, for each type
 specified in
 [Vehicle.capacities][google.cloud.optimization.v1.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];

      • getArrivalLoads

        @Deprecated
CapacityQuantity getArrivalLoads​(int index)
        Deprecated.
         Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead. Vehicle loads upon arrival at the visit location, for each type
 specified in
 [Vehicle.capacities][google.cloud.optimization.v1.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

        @Deprecated
int getArrivalLoadsCount()
        Deprecated.
         Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead. Vehicle loads upon arrival at the visit location, for each type
 specified in
 [Vehicle.capacities][google.cloud.optimization.v1.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

        @Deprecated
List<? extends CapacityQuantityOrBuilder> getArrivalLoadsOrBuilderList()
        Deprecated.
         Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead. Vehicle loads upon arrival at the visit location, for each type
 specified in
 [Vehicle.capacities][google.cloud.optimization.v1.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

        @Deprecated
CapacityQuantityOrBuilder getArrivalLoadsOrBuilder​(int index)
        Deprecated.
         Deprecated: Use
 [Transition.vehicle_loads][google.cloud.optimization.v1.ShipmentRoute.Transition.vehicle_loads]
 instead. Vehicle loads upon arrival at the visit location, for each type
 specified in
 [Vehicle.capacities][google.cloud.optimization.v1.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];

      • hasDelayBeforeStart

        @Deprecated
boolean hasDelayBeforeStart()
        Deprecated.
        google.cloud.optimization.v1.ShipmentRoute.Visit.delay_before_start is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1935
         Deprecated: Use
 [ShipmentRoute.Transition.delay_duration][google.cloud.optimization.v1.ShipmentRoute.Transition.delay_duration]
 instead. Delay occurring before the visit starts.
        .google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_start = 10 [deprecated = true];
        Returns:
        Whether the delayBeforeStart field is set.

      • getDelayBeforeStart

        @Deprecated
ShipmentRoute.Delay getDelayBeforeStart()
        Deprecated.
        google.cloud.optimization.v1.ShipmentRoute.Visit.delay_before_start is deprecated. See google/cloud/optimization/v1/fleet_routing.proto;l=1935
         Deprecated: Use
 [ShipmentRoute.Transition.delay_duration][google.cloud.optimization.v1.ShipmentRoute.Transition.delay_duration]
 instead. Delay occurring before the visit starts.
        .google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_start = 10 [deprecated = true];
        Returns:
        The delayBeforeStart.

      • getDelayBeforeStartOrBuilder

        @Deprecated
ShipmentRoute.DelayOrBuilder getDelayBeforeStartOrBuilder()
        Deprecated.
         Deprecated: Use
 [ShipmentRoute.Transition.delay_duration][google.cloud.optimization.v1.ShipmentRoute.Transition.delay_duration]
 instead. Delay occurring before the visit starts.
        .google.cloud.optimization.v1.ShipmentRoute.Delay delay_before_start = 10 [deprecated = true];

      • getDemandsList

        @Deprecated
List<CapacityQuantity> getDemandsList()
        Deprecated.
         Deprecated: Use
 [Visit.load_demands][google.cloud.optimization.v1.ShipmentRoute.Visit.load_demands]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantity demands = 5 [deprecated = true];

      • getDemands

        @Deprecated
CapacityQuantity getDemands​(int index)
        Deprecated.
         Deprecated: Use
 [Visit.load_demands][google.cloud.optimization.v1.ShipmentRoute.Visit.load_demands]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantity demands = 5 [deprecated = true];

      • getDemandsCount

        @Deprecated
int getDemandsCount()
        Deprecated.
         Deprecated: Use
 [Visit.load_demands][google.cloud.optimization.v1.ShipmentRoute.Visit.load_demands]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantity demands = 5 [deprecated = true];

      • getDemandsOrBuilderList

        @Deprecated
List<? extends CapacityQuantityOrBuilder> getDemandsOrBuilderList()
        Deprecated.
         Deprecated: Use
 [Visit.load_demands][google.cloud.optimization.v1.ShipmentRoute.Visit.load_demands]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantity demands = 5 [deprecated = true];

      • getDemandsOrBuilder

        @Deprecated
CapacityQuantityOrBuilder getDemandsOrBuilder​(int index)
        Deprecated.
         Deprecated: Use
 [Visit.load_demands][google.cloud.optimization.v1.ShipmentRoute.Visit.load_demands]
 instead.
        repeated .google.cloud.optimization.v1.CapacityQuantity demands = 5 [deprecated = true];