Package com.google.cloud.optimization.v1

Class ShipmentRoute.Visit

  • All Implemented Interfaces:
    ShipmentRoute.VisitOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    ShipmentRoute
    public static final class ShipmentRoute.Visit
extends com.google.protobuf.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
    See Also:
    Serialized Form

    • Field Detail

      • SHIPMENT_INDEX_FIELD_NUMBER

        public static final int SHIPMENT_INDEX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VISIT_REQUEST_INDEX_FIELD_NUMBER

        public static final int VISIT_REQUEST_INDEX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • START_TIME_FIELD_NUMBER

        public static final int START_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOAD_DEMANDS_FIELD_NUMBER

        public static final int LOAD_DEMANDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SHIPMENT_LABEL_FIELD_NUMBER

        public static final int SHIPMENT_LABEL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VISIT_LABEL_FIELD_NUMBER

        public static final int VISIT_LABEL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ARRIVAL_LOADS_FIELD_NUMBER

        public static final int ARRIVAL_LOADS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DELAY_BEFORE_START_FIELD_NUMBER

        public static final int DELAY_BEFORE_START_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getShipmentIndex

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

      • 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;
        Specified by:
        getIsPickup in interface ShipmentRoute.VisitOrBuilder
        Returns:
        The isPickup.

      • 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;
        Specified by:
        getVisitRequestIndex in interface ShipmentRoute.VisitOrBuilder
        Returns:
        The visitRequestIndex.

      • 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;
        Specified by:
        hasStartTime in interface ShipmentRoute.VisitOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public 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;
        Specified by:
        getStartTime in interface ShipmentRoute.VisitOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public 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;
        Specified by:
        getStartTimeOrBuilder in interface ShipmentRoute.VisitOrBuilder

      • getLoadDemandsCount

        public int getLoadDemandsCount()
        Description copied from interface: ShipmentRoute.VisitOrBuilder
         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;
        Specified by:
        getLoadDemandsCount in interface ShipmentRoute.VisitOrBuilder

      • containsLoadDemands

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

      • 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][google.cloud.optimization.v1.ShipmentRoute.Transition]
 (see this field).
        map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 11;
        Specified by:
        getLoadDemandsMap in interface ShipmentRoute.VisitOrBuilder

      • getLoadDemandsOrDefault

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

      • getLoadDemandsOrThrow

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

      • 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;
        Specified by:
        hasDetour in interface ShipmentRoute.VisitOrBuilder
        Returns:
        Whether the detour field is set.

      • getDetour

        public 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;
        Specified by:
        getDetour in interface ShipmentRoute.VisitOrBuilder
        Returns:
        The detour.

      • getDetourOrBuilder

        public 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;
        Specified by:
        getDetourOrBuilder in interface ShipmentRoute.VisitOrBuilder

      • getShipmentLabel

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

      • getShipmentLabelBytes

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

      • getVisitLabel

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

      • getVisitLabelBytes

        public 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;
        Specified by:
        getVisitLabelBytes in interface ShipmentRoute.VisitOrBuilder
        Returns:
        The bytes for visitLabel.

      • getArrivalLoadsList

        @Deprecated
public 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];
        Specified by:
        getArrivalLoadsList in interface ShipmentRoute.VisitOrBuilder

      • getArrivalLoadsOrBuilderList

        @Deprecated
public 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];
        Specified by:
        getArrivalLoadsOrBuilderList in interface ShipmentRoute.VisitOrBuilder

      • getArrivalLoadsCount

        @Deprecated
public 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];
        Specified by:
        getArrivalLoadsCount in interface ShipmentRoute.VisitOrBuilder

      • getArrivalLoads

        @Deprecated
public 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];
        Specified by:
        getArrivalLoads in interface ShipmentRoute.VisitOrBuilder

      • getArrivalLoadsOrBuilder

        @Deprecated
public 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];
        Specified by:
        getArrivalLoadsOrBuilder in interface ShipmentRoute.VisitOrBuilder

      • hasDelayBeforeStart

        @Deprecated
public 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];
        Specified by:
        hasDelayBeforeStart in interface ShipmentRoute.VisitOrBuilder
        Returns:
        Whether the delayBeforeStart field is set.

      • getDelayBeforeStart

        @Deprecated
public 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];
        Specified by:
        getDelayBeforeStart in interface ShipmentRoute.VisitOrBuilder
        Returns:
        The delayBeforeStart.

      • getDelayBeforeStartOrBuilder

        @Deprecated
public 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];
        Specified by:
        getDelayBeforeStartOrBuilder in interface ShipmentRoute.VisitOrBuilder

      • getDemandsCount

        @Deprecated
public 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];
        Specified by:
        getDemandsCount in interface ShipmentRoute.VisitOrBuilder

      • getDemands

        @Deprecated
public 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];
        Specified by:
        getDemands in interface ShipmentRoute.VisitOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ShipmentRoute.Visit parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ShipmentRoute.Visit parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ShipmentRoute.Visit parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ShipmentRoute.Visit parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ShipmentRoute.Visit parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ShipmentRoute.Visit parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ShipmentRoute.Visit parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ShipmentRoute.Visit.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ShipmentRoute.Visit.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ShipmentRoute.Visit.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ShipmentRoute.Visit> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ShipmentRoute.Visit getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder