Class TransferTypes.AgentPool (1.44.0) 
  
      
     
  
  
  
   
  
    
  
  
    
    
    
  Version 1.44.0keyboard_arrow_down  
  
 
    
    
     
    
    
    
    
    
      
  
  
  
    
public   static   final   class  TransferTypes . AgentPool   extends   GeneratedMessageV3   implements   TransferTypes . AgentPoolOrBuilder  
   
   Represents an On-Premises Agent pool.
 Protobuf type google.storagetransfer.v1.AgentPool
 
  
  
  
    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
   
  BANDWIDTH_LIMIT_FIELD_NUMBER 
  
    
public   static   final   int   BANDWIDTH_LIMIT_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  DISPLAY_NAME_FIELD_NUMBER 
  
    
public   static   final   int   DISPLAY_NAME_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  NAME_FIELD_NUMBER 
  
    
public   static   final   int   NAME_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  STATE_FIELD_NUMBER 
  
    
public   static   final   int   STATE_FIELD_NUMBER  
   
  
    
      
        Field Value  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Static Methods
   
   
  getDefaultInstance() 
  
    
public   static   TransferTypes . AgentPool   getDefaultInstance ()  
   
  
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  
   
  newBuilder() 
  
    
public   static   TransferTypes . AgentPool . Builder   newBuilder ()  
   
  
   
  newBuilder(TransferTypes.AgentPool prototype) 
  
    
public   static   TransferTypes . AgentPool . Builder   newBuilder ( TransferTypes . AgentPool   prototype )  
   
  
  
   
  
  
    
public   static   TransferTypes . AgentPool   parseDelimitedFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   TransferTypes . AgentPool   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(byte[] data) 
  
    
public   static   TransferTypes . AgentPool   parseFrom ( byte []   data )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        data 
        byte [] 
       
     
  
  
  
   
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   TransferTypes . AgentPool   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(ByteString data) 
  
    
public   static   TransferTypes . AgentPool   parseFrom ( ByteString   data )  
   
  
  
  
   
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   TransferTypes . AgentPool   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   TransferTypes . AgentPool   parseFrom ( CodedInputStream   input )  
   
  
  
  
   
  
  
    
public   static   TransferTypes . AgentPool   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   TransferTypes . AgentPool   parseFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   TransferTypes . AgentPool   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(ByteBuffer data) 
  
    
public   static   TransferTypes . AgentPool   parseFrom ( ByteBuffer   data )  
   
  
  
  
   
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   TransferTypes . AgentPool   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parser() 
  
    
public   static   Parser<TransferTypes . AgentPool >  parser ()  
   
  
  Methods
   
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        obj 
        Object  
       
     
  
  
  Overrides 
  
   
  getBandwidthLimit() 
  
    
public   TransferTypes . AgentPool . BandwidthLimit   getBandwidthLimit ()  
   
   Specifies the bandwidth limit details. If this field is unspecified, the
 default value is set as 'No Limit'.
 .google.storagetransfer.v1.AgentPool.BandwidthLimit bandwidth_limit = 5;
 
  
   
  getBandwidthLimitOrBuilder() 
  
    
public   TransferTypes . AgentPool . BandwidthLimitOrBuilder   getBandwidthLimitOrBuilder ()  
   
   Specifies the bandwidth limit details. If this field is unspecified, the
 default value is set as 'No Limit'.
 .google.storagetransfer.v1.AgentPool.BandwidthLimit bandwidth_limit = 5;
 
  
   
  getDefaultInstanceForType() 
  
    
public   TransferTypes . AgentPool   getDefaultInstanceForType ()  
   
  
   
  getDisplayName() 
  
    
public   String   getDisplayName ()  
   
   Specifies the client-specified AgentPool description.
 string display_name = 3;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The displayName.
 
       
     
  
   
  getDisplayNameBytes() 
  
    
public   ByteString   getDisplayNameBytes ()  
   
   Specifies the client-specified AgentPool description.
 string display_name = 3;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for displayName.
 
       
     
  
   
  getName() 
  
   Required. Specifies a unique string that identifies the agent pool.
 Format: projects/{project_id}/agentPools/{agent_pool_id}
 string name = 2 [(.google.api.field_behavior) = REQUIRED];
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        String  
        The name.
 
       
     
  
   
  getNameBytes() 
  
    
public   ByteString   getNameBytes ()  
   
   Required. Specifies a unique string that identifies the agent pool.
 Format: projects/{project_id}/agentPools/{agent_pool_id}
 string name = 2 [(.google.api.field_behavior) = REQUIRED];
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for name.
 
       
     
  
   
  getParserForType() 
  
    
public   Parser<TransferTypes . AgentPool >  getParserForType ()  
   
  
  Overrides 
  
   
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
   
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  getState() 
  
    
public   TransferTypes . AgentPool . State   getState ()  
   
   Output only. Specifies the state of the AgentPool.
 
 .google.storagetransfer.v1.AgentPool.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
 
  
   
  getStateValue() 
  
    
public   int   getStateValue ()  
   
   Output only. Specifies the state of the AgentPool.
 
 .google.storagetransfer.v1.AgentPool.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
        The enum numeric value on the wire for state.
 
       
     
  
   
  hasBandwidthLimit() 
  
    
public   boolean   hasBandwidthLimit ()  
   
   Specifies the bandwidth limit details. If this field is unspecified, the
 default value is set as 'No Limit'.
 .google.storagetransfer.v1.AgentPool.BandwidthLimit bandwidth_limit = 5;
 
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        boolean  
        Whether the bandwidthLimit field is set.
 
       
     
  
   
  hashCode() 
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
   
  
  Overrides 
  
   
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
   
  
  Overrides 
  
   
  newBuilderForType() 
  
    
public   TransferTypes . AgentPool . Builder   newBuilderForType ()  
   
  
   
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   TransferTypes . AgentPool . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
   
  
  
  Overrides 
  
   
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Object  
         
       
     
  
  Overrides 
  
   
  toBuilder() 
  
    
public   TransferTypes . AgentPool . Builder   toBuilder ()  
   
  
   
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
   
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
 
  
    
    
      
       
    
    
  
  
 
  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.
 
 
  
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]