Package com.google.cloud.optimization.v1

Class SkippedShipment.Reason

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.optimization.v1.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.GeneratedMessage 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SkippedShipment.Reason.Builder
    If we can explain why the shipment was skipped, reasons will be listed here.
    static enum 
    SkippedShipment.Reason.Code
    Code identifying the reason type.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CODE_FIELD_NUMBER
     
    static final int
    EXAMPLE_EXCEEDED_CAPACITY_TYPE_FIELD_NUMBER
     
    static final int
    EXAMPLE_VEHICLE_INDEX_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    SkippedShipment.Reason.Code
    getCode()
    Refer to the comments of Code.
    int
    getCodeValue()
    Refer to the comments of Code.
    static SkippedShipment.Reason
    getDefaultInstance()
     
    SkippedShipment.Reason
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getExampleExceededCapacityType()
    If the reason code is `DEMAND_EXCEEDS_VEHICLE_CAPACITY`, documents one capacity type that is exceeded.
    com.google.protobuf.ByteString
    getExampleExceededCapacityTypeBytes()
    If the reason code is `DEMAND_EXCEEDS_VEHICLE_CAPACITY`, documents one capacity type that is exceeded.
    int
    getExampleVehicleIndex()
    If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle.
    com.google.protobuf.Parser<SkippedShipment.Reason>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasExampleVehicleIndex()
    If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SkippedShipment.Reason.Builder
    newBuilder()
     
    static SkippedShipment.Reason.Builder
    newBuilder(SkippedShipment.Reason prototype)
     
    SkippedShipment.Reason.Builder
    newBuilderForType()
     
    protected SkippedShipment.Reason.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static SkippedShipment.Reason
    parseDelimitedFrom(InputStream input)
     
    static SkippedShipment.Reason
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SkippedShipment.Reason
    parseFrom(byte[] data)
     
    static SkippedShipment.Reason
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SkippedShipment.Reason
    parseFrom(com.google.protobuf.ByteString data)
     
    static SkippedShipment.Reason
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SkippedShipment.Reason
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SkippedShipment.Reason
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SkippedShipment.Reason
    parseFrom(InputStream input)
     
    static SkippedShipment.Reason
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SkippedShipment.Reason
    parseFrom(ByteBuffer data)
     
    static SkippedShipment.Reason
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SkippedShipment.Reason>
    parser()
     
    SkippedShipment.Reason.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • CODE_FIELD_NUMBER

      public static final int CODE_FIELD_NUMBER
      See Also:

    • EXAMPLE_VEHICLE_INDEX_FIELD_NUMBER

      public static final int EXAMPLE_VEHICLE_INDEX_FIELD_NUMBER
      See Also:

    • EXAMPLE_EXCEEDED_CAPACITY_TYPE_FIELD_NUMBER

      public static final int EXAMPLE_EXCEEDED_CAPACITY_TYPE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • 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.

    • getCode

      public SkippedShipment.Reason.Code getCode()
       Refer to the comments of Code.
      .google.cloud.optimization.v1.SkippedShipment.Reason.Code code = 1;
      Specified by:
      getCode in interface SkippedShipment.ReasonOrBuilder
      Returns:
      The 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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

    • parseFrom

      public static SkippedShipment.Reason parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SkippedShipment.Reason parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SkippedShipment.Reason parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SkippedShipment.Reason parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SkippedShipment.Reason parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SkippedShipment.Reason parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static SkippedShipment.Reason.Builder newBuilder()

    • newBuilder

      public static SkippedShipment.Reason.Builder newBuilder(SkippedShipment.Reason prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SkippedShipment.Reason getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SkippedShipment.Reason> parser()

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public SkippedShipment.Reason getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder