TransferTypes.AgentPool.Builder (proto-google-cloud-storage-transfer-v1 1.6.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AgentPool.Builder>
    - - com.google.storagetransfer.v1.proto.TransferTypes.AgentPool.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransferTypes.AgentPoolOrBuilder, Cloneable

Enclosing class:

TransferTypes.AgentPool
```
public static final class TransferTypes.AgentPool.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AgentPool.Builder>
implements TransferTypes.AgentPoolOrBuilder
```
```
 Represents an On-Premises Agent pool.
 
```
Protobuf type google.storagetransfer.v1.AgentPool

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransferTypes.AgentPool.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`TransferTypes.AgentPool`	`build()`
`TransferTypes.AgentPool`	`buildPartial()`
`TransferTypes.AgentPool.Builder`	`clear()`
`TransferTypes.AgentPool.Builder`	`clearBandwidthLimit()` Specifies the bandwidth limit details.
`TransferTypes.AgentPool.Builder`	`clearDisplayName()` Specifies the client-specified AgentPool description.
`TransferTypes.AgentPool.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`TransferTypes.AgentPool.Builder`	`clearName()` Required.
`TransferTypes.AgentPool.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`TransferTypes.AgentPool.Builder`	`clearState()` Output only.
`TransferTypes.AgentPool.Builder`	`clone()`
`TransferTypes.AgentPool.BandwidthLimit`	`getBandwidthLimit()` Specifies the bandwidth limit details.
`TransferTypes.AgentPool.BandwidthLimit.Builder`	`getBandwidthLimitBuilder()` Specifies the bandwidth limit details.
`TransferTypes.AgentPool.BandwidthLimitOrBuilder`	`getBandwidthLimitOrBuilder()` Specifies the bandwidth limit details.
`TransferTypes.AgentPool`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getDisplayName()` Specifies the client-specified AgentPool description.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` Specifies the client-specified AgentPool description.
`String`	`getName()` Required.
`com.google.protobuf.ByteString`	`getNameBytes()` Required.
`TransferTypes.AgentPool.State`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`boolean`	`hasBandwidthLimit()` Specifies the bandwidth limit details.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`TransferTypes.AgentPool.Builder`	`mergeBandwidthLimit(TransferTypes.AgentPool.BandwidthLimit value)` Specifies the bandwidth limit details.
`TransferTypes.AgentPool.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`TransferTypes.AgentPool.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`TransferTypes.AgentPool.Builder`	`mergeFrom(TransferTypes.AgentPool other)`
`TransferTypes.AgentPool.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`TransferTypes.AgentPool.Builder`	`setBandwidthLimit(TransferTypes.AgentPool.BandwidthLimit.Builder builderForValue)` Specifies the bandwidth limit details.
`TransferTypes.AgentPool.Builder`	`setBandwidthLimit(TransferTypes.AgentPool.BandwidthLimit value)` Specifies the bandwidth limit details.
`TransferTypes.AgentPool.Builder`	`setDisplayName(String value)` Specifies the client-specified AgentPool description.
`TransferTypes.AgentPool.Builder`	`setDisplayNameBytes(com.google.protobuf.ByteString value)` Specifies the client-specified AgentPool description.
`TransferTypes.AgentPool.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`TransferTypes.AgentPool.Builder`	`setName(String value)` Required.
`TransferTypes.AgentPool.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` Required.
`TransferTypes.AgentPool.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`TransferTypes.AgentPool.Builder`	`setState(TransferTypes.AgentPool.State value)` Output only.
`TransferTypes.AgentPool.Builder`	`setStateValue(int value)` Output only.
`TransferTypes.AgentPool.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - 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.Builder<TransferTypes.AgentPool.Builder>
  - clear
```
public TransferTypes.AgentPool.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AgentPool.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AgentPool.Builder>
  - getDefaultInstanceForType
```
public TransferTypes.AgentPool getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public TransferTypes.AgentPool build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public TransferTypes.AgentPool buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public TransferTypes.AgentPool.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AgentPool.Builder>
  - setField
```
public TransferTypes.AgentPool.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AgentPool.Builder>
  - clearField
```
public TransferTypes.AgentPool.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AgentPool.Builder>
  - clearOneof
```
public TransferTypes.AgentPool.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AgentPool.Builder>
  - setRepeatedField
```
public TransferTypes.AgentPool.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        int index,
                                                        Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AgentPool.Builder>
  - addRepeatedField
```
public TransferTypes.AgentPool.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AgentPool.Builder>
  - mergeFrom
```
public TransferTypes.AgentPool.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferTypes.AgentPool.Builder>
  - mergeFrom
```
public TransferTypes.AgentPool.Builder mergeFrom(TransferTypes.AgentPool other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AgentPool.Builder>
  - mergeFrom
```
public TransferTypes.AgentPool.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<TransferTypes.AgentPool.Builder>
    
    Throws:
    
    IOException
  - getName
```
public String 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];
    Specified by:
    
    getName in interface TransferTypes.AgentPoolOrBuilder
    
    Returns:
    
    The name.
  - getNameBytes
```
public com.google.protobuf.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];
    Specified by:
    
    getNameBytes in interface TransferTypes.AgentPoolOrBuilder
    
    Returns:
    
    The bytes for name.
  - setName
```
public TransferTypes.AgentPool.Builder setName(String value)
```
```
 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];
    Parameters:
    
    value - The name to set.
    
    Returns:
    
    This builder for chaining.
  - clearName
```
public TransferTypes.AgentPool.Builder clearName()
```
```
 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:
    
    This builder for chaining.
  - setNameBytes
```
public TransferTypes.AgentPool.Builder setNameBytes(com.google.protobuf.ByteString value)
```
```
 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];
    Parameters:
    
    value - The bytes for name to set.
    
    Returns:
    
    This builder for chaining.
  - getDisplayName
```
public String getDisplayName()
```
```
 Specifies the client-specified AgentPool description.
 
```
    string display_name = 3;
    Specified by:
    
    getDisplayName in interface TransferTypes.AgentPoolOrBuilder
    
    Returns:
    
    The displayName.
  - getDisplayNameBytes
```
public com.google.protobuf.ByteString getDisplayNameBytes()
```
```
 Specifies the client-specified AgentPool description.
 
```
    string display_name = 3;
    Specified by:
    
    getDisplayNameBytes in interface TransferTypes.AgentPoolOrBuilder
    
    Returns:
    
    The bytes for displayName.
  - setDisplayName
```
public TransferTypes.AgentPool.Builder setDisplayName(String value)
```
```
 Specifies the client-specified AgentPool description.
 
```
    string display_name = 3;
    Parameters:
    
    value - The displayName to set.
    
    Returns:
    
    This builder for chaining.
  - clearDisplayName
```
public TransferTypes.AgentPool.Builder clearDisplayName()
```
```
 Specifies the client-specified AgentPool description.
 
```
    string display_name = 3;
    Returns:
    
    This builder for chaining.
  - setDisplayNameBytes
```
public TransferTypes.AgentPool.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
```
```
 Specifies the client-specified AgentPool description.
 
```
    string display_name = 3;
    Parameters:
    
    value - The bytes for displayName to set.
    
    Returns:
    
    This builder for chaining.
  - 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];
    Specified by:
    
    getStateValue in interface TransferTypes.AgentPoolOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for state.
  - setStateValue
```
public TransferTypes.AgentPool.Builder setStateValue(int value)
```
```
 Output only. Specifies the state of the AgentPool.
 
```
    .google.storagetransfer.v1.AgentPool.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Parameters:
    
    value - The enum numeric value on the wire for state to set.
    
    Returns:
    
    This builder for chaining.
  - 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];
    Specified by:
    
    getState in interface TransferTypes.AgentPoolOrBuilder
    
    Returns:
    
    The state.
  - setState
```
public TransferTypes.AgentPool.Builder setState(TransferTypes.AgentPool.State value)
```
```
 Output only. Specifies the state of the AgentPool.
 
```
    .google.storagetransfer.v1.AgentPool.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Parameters:
    
    value - The state to set.
    
    Returns:
    
    This builder for chaining.
  - clearState
```
public TransferTypes.AgentPool.Builder clearState()
```
```
 Output only. Specifies the state of the AgentPool.
 
```
    .google.storagetransfer.v1.AgentPool.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    This builder for chaining.
  - 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;
    Specified by:
    
    hasBandwidthLimit in interface TransferTypes.AgentPoolOrBuilder
    
    Returns:
    
    Whether the bandwidthLimit field is set.
  - 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;
    Specified by:
    
    getBandwidthLimit in interface TransferTypes.AgentPoolOrBuilder
    
    Returns:
    
    The bandwidthLimit.
  - setBandwidthLimit
```
public TransferTypes.AgentPool.Builder setBandwidthLimit(TransferTypes.AgentPool.BandwidthLimit value)
```
```
 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;
  - setBandwidthLimit
```
public TransferTypes.AgentPool.Builder setBandwidthLimit(TransferTypes.AgentPool.BandwidthLimit.Builder builderForValue)
```
```
 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;
  - mergeBandwidthLimit
```
public TransferTypes.AgentPool.Builder mergeBandwidthLimit(TransferTypes.AgentPool.BandwidthLimit value)
```
```
 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;
  - clearBandwidthLimit
```
public TransferTypes.AgentPool.Builder clearBandwidthLimit()
```
```
 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;
  - getBandwidthLimitBuilder
```
public TransferTypes.AgentPool.BandwidthLimit.Builder getBandwidthLimitBuilder()
```
```
 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;
    Specified by:
    
    getBandwidthLimitOrBuilder in interface TransferTypes.AgentPoolOrBuilder
  - setUnknownFields
```
public final TransferTypes.AgentPool.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AgentPool.Builder>
  - mergeUnknownFields
```
public final TransferTypes.AgentPool.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TransferTypes.AgentPool.Builder>

Class TransferTypes.AgentPool.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getName

getNameBytes

setName

clearName

setNameBytes

getDisplayName

getDisplayNameBytes

setDisplayName

clearDisplayName

setDisplayNameBytes

getStateValue

setStateValue

getState

setState

clearState

hasBandwidthLimit

getBandwidthLimit

setBandwidthLimit

setBandwidthLimit

mergeBandwidthLimit

clearBandwidthLimit

getBandwidthLimitBuilder

getBandwidthLimitOrBuilder

setUnknownFields

mergeUnknownFields