Package com.google.cloud.optimization.v1

Enum SkippedShipment.Reason.Code

java.lang.Object
java.lang.Enum<SkippedShipment.Reason.Code>
com.google.cloud.optimization.v1.SkippedShipment.Reason.Code
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SkippedShipment.Reason.Code>
Enclosing class:
SkippedShipment.Reason
public static enum SkippedShipment.Reason.Code extends Enum<SkippedShipment.Reason.Code> implements com.google.protobuf.ProtocolMessageEnum
 Code identifying the reason type. The order here is meaningless. In
 particular, it gives no indication of whether a given reason will
 appear before another in the solution, if both apply.
Protobuf enum google.cloud.optimization.v1.SkippedShipment.Reason.Code

  • Enum Constant Details

    • CODE_UNSPECIFIED

      public static final SkippedShipment.Reason.Code CODE_UNSPECIFIED
       This should never be used. If we are unable to understand why a
 shipment was skipped, we simply return an empty set of reasons.
      CODE_UNSPECIFIED = 0;

    • NO_VEHICLE

      public static final SkippedShipment.Reason.Code NO_VEHICLE
       There is no vehicle in the model making all shipments infeasible.
      NO_VEHICLE = 1;

    • DEMAND_EXCEEDS_VEHICLE_CAPACITY

      public static final SkippedShipment.Reason.Code DEMAND_EXCEEDS_VEHICLE_CAPACITY
       The demand of the shipment exceeds a vehicle's capacity for some
 capacity types, one of which is `example_exceeded_capacity_type`.
      DEMAND_EXCEEDS_VEHICLE_CAPACITY = 2;

    • CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT

      public static final SkippedShipment.Reason.Code CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT
       The minimum distance necessary to perform this shipment, i.e. from
 the vehicle's `start_location` to the shipment's pickup and/or delivery
 locations and to the vehicle's end location exceeds the vehicle's
 `route_distance_limit`.

 Note that for this computation we use the geodesic distances.
      CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT = 3;

    • CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT

      public static final SkippedShipment.Reason.Code CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT
       The minimum time necessary to perform this shipment, including travel
 time, wait time and service time exceeds the vehicle's
 `route_duration_limit`.

 Note: travel time is computed in the best-case scenario, namely as
 geodesic distance x 36 m/s (roughly 130 km/hour).
      CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT = 4;

    • CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT

      public static final SkippedShipment.Reason.Code CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT
       Same as above but we only compare minimum travel time and the
 vehicle's `travel_duration_limit`.
      CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT = 5;

    • CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS

      public static final SkippedShipment.Reason.Code CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS
       The vehicle cannot perform this shipment in the best-case scenario
 (see `CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT` for time
 computation) if it starts at its earliest start time: the total time
 would make the vehicle end after its latest end time.
      CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS = 6;

    • VEHICLE_NOT_ALLOWED

      public static final SkippedShipment.Reason.Code VEHICLE_NOT_ALLOWED
       The `allowed_vehicle_indices` field of the shipment is not empty and
 this vehicle does not belong to it.
      VEHICLE_NOT_ALLOWED = 7;

    • UNRECOGNIZED

      public static final SkippedShipment.Reason.Code UNRECOGNIZED

  • Field Details

    • CODE_UNSPECIFIED_VALUE

      public static final int CODE_UNSPECIFIED_VALUE
       This should never be used. If we are unable to understand why a
 shipment was skipped, we simply return an empty set of reasons.
      CODE_UNSPECIFIED = 0;
      See Also:

    • NO_VEHICLE_VALUE

      public static final int NO_VEHICLE_VALUE
       There is no vehicle in the model making all shipments infeasible.
      NO_VEHICLE = 1;
      See Also:

    • DEMAND_EXCEEDS_VEHICLE_CAPACITY_VALUE

      public static final int DEMAND_EXCEEDS_VEHICLE_CAPACITY_VALUE
       The demand of the shipment exceeds a vehicle's capacity for some
 capacity types, one of which is `example_exceeded_capacity_type`.
      DEMAND_EXCEEDS_VEHICLE_CAPACITY = 2;
      See Also:

    • CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT_VALUE

      public static final int CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT_VALUE
       The minimum distance necessary to perform this shipment, i.e. from
 the vehicle's `start_location` to the shipment's pickup and/or delivery
 locations and to the vehicle's end location exceeds the vehicle's
 `route_distance_limit`.

 Note that for this computation we use the geodesic distances.
      CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT = 3;
      See Also:

    • CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT_VALUE

      public static final int CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT_VALUE
       The minimum time necessary to perform this shipment, including travel
 time, wait time and service time exceeds the vehicle's
 `route_duration_limit`.

 Note: travel time is computed in the best-case scenario, namely as
 geodesic distance x 36 m/s (roughly 130 km/hour).
      CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT = 4;
      See Also:

    • CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT_VALUE

      public static final int CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT_VALUE
       Same as above but we only compare minimum travel time and the
 vehicle's `travel_duration_limit`.
      CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT = 5;
      See Also:

    • CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS_VALUE

      public static final int CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS_VALUE
       The vehicle cannot perform this shipment in the best-case scenario
 (see `CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT` for time
 computation) if it starts at its earliest start time: the total time
 would make the vehicle end after its latest end time.
      CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS = 6;
      See Also:

    • VEHICLE_NOT_ALLOWED_VALUE

      public static final int VEHICLE_NOT_ALLOWED_VALUE
       The `allowed_vehicle_indices` field of the shipment is not empty and
 this vehicle does not belong to it.
      VEHICLE_NOT_ALLOWED = 7;
      See Also:

  • Method Details

    • values

      public static SkippedShipment.Reason.Code[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static SkippedShipment.Reason.Code valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static SkippedShipment.Reason.Code valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static SkippedShipment.Reason.Code forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<SkippedShipment.Reason.Code> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static SkippedShipment.Reason.Code valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null