Send feedback
  
   
 
  
    
      Class ShipmentTypeRequirement (1.37.0)
    
    
       
    
    
      
      Stay organized with collections
     
    
      
      Save and categorize content based on your preferences.
     
    
  
      
     
  
  
   
  
    
  
  
    
    
    
  Version 1.37.0keyboard_arrow_down  
  
 
    
    
     
    
    
    
    
    
      
  
  
  
    
public   final   class  ShipmentTypeRequirement   extends   GeneratedMessageV3   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
 
  
  
  
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int) 
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  DEPENDENT_SHIPMENT_TYPES_FIELD_NUMBER 
  
    
public   static   final   int   DEPENDENT_SHIPMENT_TYPES_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  REQUIRED_SHIPMENT_TYPE_ALTERNATIVES_FIELD_NUMBER 
  
    
public   static   final   int   REQUIRED_SHIPMENT_TYPE_ALTERNATIVES_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  REQUIREMENT_MODE_FIELD_NUMBER 
  
    
public   static   final   int   REQUIREMENT_MODE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Static Methods
   
   
  getDefaultInstance() 
  
    
public   static   ShipmentTypeRequirement   getDefaultInstance ()  
   
  
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  
   
  newBuilder() 
  
    
public   static   ShipmentTypeRequirement . Builder   newBuilder ()  
   
  
   
  newBuilder(ShipmentTypeRequirement prototype) 
  
    
public   static   ShipmentTypeRequirement . Builder   newBuilder ( ShipmentTypeRequirement   prototype )  
   
  
  
   
  
  
    
public   static   ShipmentTypeRequirement   parseDelimitedFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   ShipmentTypeRequirement   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(byte[] data) 
  
    
public   static   ShipmentTypeRequirement   parseFrom ( byte []   data )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        data 
        byte [] 
       
     
  
  
  
   
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   ShipmentTypeRequirement   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(ByteString data) 
  
    
public   static   ShipmentTypeRequirement   parseFrom ( ByteString   data )  
   
  
  
  
   
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   ShipmentTypeRequirement   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   ShipmentTypeRequirement   parseFrom ( CodedInputStream   input )  
   
  
  
  
   
  
  
    
public   static   ShipmentTypeRequirement   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   ShipmentTypeRequirement   parseFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   ShipmentTypeRequirement   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(ByteBuffer data) 
  
    
public   static   ShipmentTypeRequirement   parseFrom ( ByteBuffer   data )  
   
  
  
  
   
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   ShipmentTypeRequirement   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parser() 
  
    
public   static   Parser<ShipmentTypeRequirement>   parser ()  
   
  
  Methods
   
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        obj 
        Object  
       
     
  
  
  Overrides 
  
   
  getDefaultInstanceForType() 
  
    
public   ShipmentTypeRequirement   getDefaultInstanceForType ()  
   
  
   
  getDependentShipmentTypes(int index) 
  
    
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;
 
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        index 
        int The index of the element to return.
 
       
     
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The dependentShipmentTypes at the given index.
 
       
     
  
   
  getDependentShipmentTypesBytes(int index) 
  
    
public   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;
 
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        index 
        int The index of the value to return.
 
       
     
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes of the dependentShipmentTypes at the given index.
 
       
     
  
   
  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;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
        The count of dependentShipmentTypes.
 
       
     
  
   
  getDependentShipmentTypesList() 
  
    
public   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;
 
  
   
  getParserForType() 
  
    
public   Parser<ShipmentTypeRequirement>   getParserForType ()  
   
  
  Overrides 
  
   
  getRequiredShipmentTypeAlternatives(int index) 
  
    
public   String   getRequiredShipmentTypeAlternatives ( int   index )  
   
   List of alternative shipment types required by the
 dependent_shipment_types.
 repeated string required_shipment_type_alternatives = 1;
 
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        index 
        int The index of the element to return.
 
       
     
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The requiredShipmentTypeAlternatives at the given index.
 
       
     
  
   
  getRequiredShipmentTypeAlternativesBytes(int index) 
  
    
public   ByteString   getRequiredShipmentTypeAlternativesBytes ( int   index )  
   
   List of alternative shipment types required by the
 dependent_shipment_types.
 repeated string required_shipment_type_alternatives = 1;
 
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        index 
        int The index of the value to return.
 
       
     
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes of the requiredShipmentTypeAlternatives at the given index.
 
       
     
  
   
  getRequiredShipmentTypeAlternativesCount() 
  
    
public   int   getRequiredShipmentTypeAlternativesCount ()  
   
   List of alternative shipment types required by the
 dependent_shipment_types.
 repeated string required_shipment_type_alternatives = 1;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
        The count of requiredShipmentTypeAlternatives.
 
       
     
  
   
  getRequiredShipmentTypeAlternativesList() 
  
    
public   ProtocolStringList   getRequiredShipmentTypeAlternativesList ()  
   
   List of alternative shipment types required by the
 dependent_shipment_types.
 repeated string required_shipment_type_alternatives = 1;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ProtocolStringList  
        A list containing the requiredShipmentTypeAlternatives.
 
       
     
  
   
  getRequirementMode() 
  
    
public   ShipmentTypeRequirement . RequirementMode   getRequirementMode ()  
   
   Mode applied to the requirement.
 
 .google.cloud.optimization.v1.ShipmentTypeRequirement.RequirementMode requirement_mode = 3;
 
 
  
   
  getRequirementModeValue() 
  
    
public   int   getRequirementModeValue ()  
   
   Mode applied to the requirement.
 
 .google.cloud.optimization.v1.ShipmentTypeRequirement.RequirementMode requirement_mode = 3;
 
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
        The enum numeric value on the wire for requirementMode.
 
       
     
  
   
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
   
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  hashCode() 
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
   
  
  Overrides 
  
   
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
   
  
  Overrides 
  
   
  newBuilderForType() 
  
    
public   ShipmentTypeRequirement . Builder   newBuilderForType ()  
   
  
   
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   ShipmentTypeRequirement . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
   
  
  
  Overrides 
  
   
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Object  
         
       
     
  
  Overrides 
  
   
  toBuilder() 
  
    
public   ShipmentTypeRequirement . Builder   toBuilder ()  
   
  
   
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
   
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
 
  
    
    
      
    
     
  
       
         
  
  
    
    Send feedback
  
   
 
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-30 UTC.
 
 
  
  
    
    
    
      
  
  
    Need to tell us more?
  
   
 
     
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]