Class ShipmentTypeRequirement

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.optimization.v1.ShipmentTypeRequirement
All Implemented Interfaces:
ShipmentTypeRequirementOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class ShipmentTypeRequirement extends com.google.protobuf.GeneratedMessage implements ShipmentTypeRequirementOrBuilder
 Specifies requirements between shipments based on their shipment_type.
 The specifics of the requirement are defined by the requirement mode.
 
Protobuf type google.cloud.optimization.v1.ShipmentTypeRequirement
See Also:
  • Field Details

    • REQUIRED_SHIPMENT_TYPE_ALTERNATIVES_FIELD_NUMBER

      public static final int REQUIRED_SHIPMENT_TYPE_ALTERNATIVES_FIELD_NUMBER
      See Also:
    • DEPENDENT_SHIPMENT_TYPES_FIELD_NUMBER

      public static final int DEPENDENT_SHIPMENT_TYPES_FIELD_NUMBER
      See Also:
    • REQUIREMENT_MODE_FIELD_NUMBER

      public static final int REQUIREMENT_MODE_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
    • getRequiredShipmentTypeAlternativesList

      public com.google.protobuf.ProtocolStringList getRequiredShipmentTypeAlternativesList()
       List of alternative shipment types required by the
       `dependent_shipment_types`.
       
      repeated string required_shipment_type_alternatives = 1;
      Specified by:
      getRequiredShipmentTypeAlternativesList in interface ShipmentTypeRequirementOrBuilder
      Returns:
      A list containing the requiredShipmentTypeAlternatives.
    • getRequiredShipmentTypeAlternativesCount

      public int getRequiredShipmentTypeAlternativesCount()
       List of alternative shipment types required by the
       `dependent_shipment_types`.
       
      repeated string required_shipment_type_alternatives = 1;
      Specified by:
      getRequiredShipmentTypeAlternativesCount in interface ShipmentTypeRequirementOrBuilder
      Returns:
      The count of requiredShipmentTypeAlternatives.
    • getRequiredShipmentTypeAlternatives

      public String getRequiredShipmentTypeAlternatives(int index)
       List of alternative shipment types required by the
       `dependent_shipment_types`.
       
      repeated string required_shipment_type_alternatives = 1;
      Specified by:
      getRequiredShipmentTypeAlternatives in interface ShipmentTypeRequirementOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The requiredShipmentTypeAlternatives at the given index.
    • getRequiredShipmentTypeAlternativesBytes

      public com.google.protobuf.ByteString getRequiredShipmentTypeAlternativesBytes(int index)
       List of alternative shipment types required by the
       `dependent_shipment_types`.
       
      repeated string required_shipment_type_alternatives = 1;
      Specified by:
      getRequiredShipmentTypeAlternativesBytes in interface ShipmentTypeRequirementOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the requiredShipmentTypeAlternatives at the given index.
    • getDependentShipmentTypesList

      public com.google.protobuf.ProtocolStringList getDependentShipmentTypesList()
       All shipments with a type in the `dependent_shipment_types` field require
       at least one shipment of type `required_shipment_type_alternatives` to be
       visited on the same route.
      
       NOTE: Chains of requirements such that a `shipment_type` depends on itself
       are not allowed.
       
      repeated string dependent_shipment_types = 2;
      Specified by:
      getDependentShipmentTypesList in interface ShipmentTypeRequirementOrBuilder
      Returns:
      A list containing the dependentShipmentTypes.
    • getDependentShipmentTypesCount

      public int getDependentShipmentTypesCount()
       All shipments with a type in the `dependent_shipment_types` field require
       at least one shipment of type `required_shipment_type_alternatives` to be
       visited on the same route.
      
       NOTE: Chains of requirements such that a `shipment_type` depends on itself
       are not allowed.
       
      repeated string dependent_shipment_types = 2;
      Specified by:
      getDependentShipmentTypesCount in interface ShipmentTypeRequirementOrBuilder
      Returns:
      The count of dependentShipmentTypes.
    • getDependentShipmentTypes

      public String getDependentShipmentTypes(int index)
       All shipments with a type in the `dependent_shipment_types` field require
       at least one shipment of type `required_shipment_type_alternatives` to be
       visited on the same route.
      
       NOTE: Chains of requirements such that a `shipment_type` depends on itself
       are not allowed.
       
      repeated string dependent_shipment_types = 2;
      Specified by:
      getDependentShipmentTypes in interface ShipmentTypeRequirementOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The dependentShipmentTypes at the given index.
    • getDependentShipmentTypesBytes

      public com.google.protobuf.ByteString getDependentShipmentTypesBytes(int index)
       All shipments with a type in the `dependent_shipment_types` field require
       at least one shipment of type `required_shipment_type_alternatives` to be
       visited on the same route.
      
       NOTE: Chains of requirements such that a `shipment_type` depends on itself
       are not allowed.
       
      repeated string dependent_shipment_types = 2;
      Specified by:
      getDependentShipmentTypesBytes in interface ShipmentTypeRequirementOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the dependentShipmentTypes at the given index.
    • getRequirementModeValue

      public int getRequirementModeValue()
       Mode applied to the requirement.
       
      .google.cloud.optimization.v1.ShipmentTypeRequirement.RequirementMode requirement_mode = 3;
      Specified by:
      getRequirementModeValue in interface ShipmentTypeRequirementOrBuilder
      Returns:
      The enum numeric value on the wire for requirementMode.
    • getRequirementMode

      public ShipmentTypeRequirement.RequirementMode getRequirementMode()
       Mode applied to the requirement.
       
      .google.cloud.optimization.v1.ShipmentTypeRequirement.RequirementMode requirement_mode = 3;
      Specified by:
      getRequirementMode in interface ShipmentTypeRequirementOrBuilder
      Returns:
      The requirementMode.
    • 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 ShipmentTypeRequirement parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ShipmentTypeRequirement parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ShipmentTypeRequirement parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ShipmentTypeRequirement parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static ShipmentTypeRequirement parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

      public static ShipmentTypeRequirement parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ShipmentTypeRequirement parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ShipmentTypeRequirement parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static ShipmentTypeRequirement parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ShipmentTypeRequirement parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static ShipmentTypeRequirement parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public ShipmentTypeRequirement.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static ShipmentTypeRequirement.Builder newBuilder()
    • newBuilder

      public static ShipmentTypeRequirement.Builder newBuilder(ShipmentTypeRequirement prototype)
    • toBuilder

      public ShipmentTypeRequirement.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected ShipmentTypeRequirement.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static ShipmentTypeRequirement getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<ShipmentTypeRequirement> parser()
    • getParserForType

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