Package com.google.cloud.optimization.v1

Class SkippedShipment.Reason

  • All Implemented Interfaces:
    SkippedShipment.ReasonOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    SkippedShipment
    public static final class SkippedShipment.Reason
extends com.google.protobuf.GeneratedMessageV3
implements SkippedShipment.ReasonOrBuilder
     If we can explain why the shipment was skipped, reasons will be listed
 here. If the reason is not the same for all vehicles, `reason` will have
 more than 1 element. A skipped shipment cannot have duplicate reasons,
 i.e. where all fields are the same except for `example_vehicle_index`.
 Example:
 ```
 reasons {
   code: DEMAND_EXCEEDS_VEHICLE_CAPACITY
   example_vehicle_index: 1
   example_exceeded_capacity_type: "Apples"
 }
 reasons {
   code: DEMAND_EXCEEDS_VEHICLE_CAPACITY
   example_vehicle_index: 3
   example_exceeded_capacity_type: "Pears"
 }
 reasons {
   code: CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT
   example_vehicle_index: 1
 }
 ```
 The skipped shipment is incompatible with all vehicles. The reasons may
 be different for all vehicles but at least one vehicle's "Apples"
 capacity would be exceeded (including vehicle 1), at least one vehicle's
 "Pears" capacity would be exceeded (including vehicle 3) and at least one
 vehicle's distance limit would be exceeded (including vehicle 1).
    Protobuf type google.cloud.optimization.v1.SkippedShipment.Reason
    See Also:
    Serialized Form

    • Field Detail

      • EXAMPLE_VEHICLE_INDEX_FIELD_NUMBER

        public static final int EXAMPLE_VEHICLE_INDEX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXAMPLE_EXCEEDED_CAPACITY_TYPE_FIELD_NUMBER

        public static final int EXAMPLE_EXCEEDED_CAPACITY_TYPE_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()

      • internalGetFieldAccessorTable

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

      • getCodeValue

        public int getCodeValue()
         Refer to the comments of Code.
        .google.cloud.optimization.v1.SkippedShipment.Reason.Code code = 1;
        Specified by:
        getCodeValue in interface SkippedShipment.ReasonOrBuilder
        Returns:
        The enum numeric value on the wire for code.

      • hasExampleVehicleIndex

        public boolean hasExampleVehicleIndex()
         If the reason is related to a shipment-vehicle incompatibility, this
 field provides the index of one relevant vehicle.
        optional int32 example_vehicle_index = 2;
        Specified by:
        hasExampleVehicleIndex in interface SkippedShipment.ReasonOrBuilder
        Returns:
        Whether the exampleVehicleIndex field is set.

      • getExampleVehicleIndex

        public int getExampleVehicleIndex()
         If the reason is related to a shipment-vehicle incompatibility, this
 field provides the index of one relevant vehicle.
        optional int32 example_vehicle_index = 2;
        Specified by:
        getExampleVehicleIndex in interface SkippedShipment.ReasonOrBuilder
        Returns:
        The exampleVehicleIndex.

      • getExampleExceededCapacityType

        public String getExampleExceededCapacityType()
         If the reason code is `DEMAND_EXCEEDS_VEHICLE_CAPACITY`, documents one
 capacity type that is exceeded.
        string example_exceeded_capacity_type = 3;
        Specified by:
        getExampleExceededCapacityType in interface SkippedShipment.ReasonOrBuilder
        Returns:
        The exampleExceededCapacityType.

      • getExampleExceededCapacityTypeBytes

        public com.google.protobuf.ByteString getExampleExceededCapacityTypeBytes()
         If the reason code is `DEMAND_EXCEEDS_VEHICLE_CAPACITY`, documents one
 capacity type that is exceeded.
        string example_exceeded_capacity_type = 3;
        Specified by:
        getExampleExceededCapacityTypeBytes in interface SkippedShipment.ReasonOrBuilder
        Returns:
        The bytes for exampleExceededCapacityType.

      • 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 SkippedShipment.Reason parseFrom​(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<SkippedShipment.Reason> 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 SkippedShipment.Reason getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder