Package com.google.cloud.optimization.v1

Enum ShipmentTypeRequirement.RequirementMode

    • Enum Constant Detail

      • REQUIREMENT_MODE_UNSPECIFIED

        public static final ShipmentTypeRequirement.RequirementMode REQUIREMENT_MODE_UNSPECIFIED
         Unspecified requirement mode. This value should never be used.
        REQUIREMENT_MODE_UNSPECIFIED = 0;

      • PERFORMED_BY_SAME_VEHICLE

        public static final ShipmentTypeRequirement.RequirementMode PERFORMED_BY_SAME_VEHICLE
         In this mode, all "dependent" shipments must share the same vehicle as at
 least one of their "required" shipments.
        PERFORMED_BY_SAME_VEHICLE = 1;

      • IN_SAME_VEHICLE_AT_PICKUP_TIME

        public static final ShipmentTypeRequirement.RequirementMode IN_SAME_VEHICLE_AT_PICKUP_TIME
         With the `IN_SAME_VEHICLE_AT_PICKUP_TIME` mode, all "dependent"
 shipments need to have at least one "required" shipment on their vehicle
 at the time of their pickup.

 A "dependent" shipment pickup must therefore have either:

 * A delivery-only "required" shipment delivered on the route after, or
 * A "required" shipment picked up on the route before it, and if the
   "required" shipment has a delivery, this delivery must be performed
   after the "dependent" shipment's pickup.
        IN_SAME_VEHICLE_AT_PICKUP_TIME = 2;

      • IN_SAME_VEHICLE_AT_DELIVERY_TIME

        public static final ShipmentTypeRequirement.RequirementMode IN_SAME_VEHICLE_AT_DELIVERY_TIME
         Same as before, except the "dependent" shipments need to have a
 "required" shipment on their vehicle at the time of their *delivery*.
        IN_SAME_VEHICLE_AT_DELIVERY_TIME = 3;

    • Field Detail

      • REQUIREMENT_MODE_UNSPECIFIED_VALUE

        public static final int REQUIREMENT_MODE_UNSPECIFIED_VALUE
         Unspecified requirement mode. This value should never be used.
        REQUIREMENT_MODE_UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • PERFORMED_BY_SAME_VEHICLE_VALUE

        public static final int PERFORMED_BY_SAME_VEHICLE_VALUE
         In this mode, all "dependent" shipments must share the same vehicle as at
 least one of their "required" shipments.
        PERFORMED_BY_SAME_VEHICLE = 1;
        See Also:
        Constant Field Values

      • IN_SAME_VEHICLE_AT_PICKUP_TIME_VALUE

        public static final int IN_SAME_VEHICLE_AT_PICKUP_TIME_VALUE
         With the `IN_SAME_VEHICLE_AT_PICKUP_TIME` mode, all "dependent"
 shipments need to have at least one "required" shipment on their vehicle
 at the time of their pickup.

 A "dependent" shipment pickup must therefore have either:

 * A delivery-only "required" shipment delivered on the route after, or
 * A "required" shipment picked up on the route before it, and if the
   "required" shipment has a delivery, this delivery must be performed
   after the "dependent" shipment's pickup.
        IN_SAME_VEHICLE_AT_PICKUP_TIME = 2;
        See Also:
        Constant Field Values

      • IN_SAME_VEHICLE_AT_DELIVERY_TIME_VALUE

        public static final int IN_SAME_VEHICLE_AT_DELIVERY_TIME_VALUE
         Same as before, except the "dependent" shipments need to have a
 "required" shipment on their vehicle at the time of their *delivery*.
        IN_SAME_VEHICLE_AT_DELIVERY_TIME = 3;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static ShipmentTypeRequirement.RequirementMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ShipmentTypeRequirement.RequirementMode c : ShipmentTypeRequirement.RequirementMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ShipmentTypeRequirement.RequirementMode 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 ShipmentTypeRequirement.RequirementMode 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 ShipmentTypeRequirement.RequirementMode forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

      • 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 final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

      • valueOf

        public static ShipmentTypeRequirement.RequirementMode 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