Class TransferTypes.AgentPool.Builder (1.43.0)

public static final class TransferTypes.AgentPool.Builder extends GeneratedMessageV3.Builder<TransferTypes.AgentPool.Builder> implements TransferTypes.AgentPoolOrBuilder

Represents an On-Premises Agent pool.

Protobuf type google.storagetransfer.v1.AgentPool

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.AgentPool.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransferTypes.AgentPool.Builder
Overrides

build()

public TransferTypes.AgentPool build()
Returns
Type Description
TransferTypes.AgentPool

buildPartial()

public TransferTypes.AgentPool buildPartial()
Returns
Type Description
TransferTypes.AgentPool

clear()

public TransferTypes.AgentPool.Builder clear()
Returns
Type Description
TransferTypes.AgentPool.Builder
Overrides

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;

Returns
Type Description
TransferTypes.AgentPool.Builder

clearDisplayName()

public TransferTypes.AgentPool.Builder clearDisplayName()

Specifies the client-specified AgentPool description.

string display_name = 3;

Returns
Type Description
TransferTypes.AgentPool.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TransferTypes.AgentPool.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TransferTypes.AgentPool.Builder
Overrides

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
Type Description
TransferTypes.AgentPool.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TransferTypes.AgentPool.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TransferTypes.AgentPool.Builder
Overrides

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
Type Description
TransferTypes.AgentPool.Builder

This builder for chaining.

clone()

public TransferTypes.AgentPool.Builder clone()
Returns
Type Description
TransferTypes.AgentPool.Builder
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;

Returns
Type Description
TransferTypes.AgentPool.BandwidthLimit

The bandwidthLimit.

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;

Returns
Type Description
TransferTypes.AgentPool.BandwidthLimit.Builder

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;

Returns
Type Description
TransferTypes.AgentPool.BandwidthLimitOrBuilder

getDefaultInstanceForType()

public TransferTypes.AgentPool getDefaultInstanceForType()
Returns
Type Description
TransferTypes.AgentPool

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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()

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];

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.

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];

Returns
Type Description
TransferTypes.AgentPool.State

The state.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBandwidthLimit(TransferTypes.AgentPool.BandwidthLimit value)

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;

Parameter
Name Description
value TransferTypes.AgentPool.BandwidthLimit
Returns
Type Description
TransferTypes.AgentPool.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TransferTypes.AgentPool.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.AgentPool.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TransferTypes.AgentPool.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TransferTypes.AgentPool.Builder
Overrides

mergeFrom(TransferTypes.AgentPool other)

public TransferTypes.AgentPool.Builder mergeFrom(TransferTypes.AgentPool other)
Parameter
Name Description
other TransferTypes.AgentPool
Returns
Type Description
TransferTypes.AgentPool.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.AgentPool.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.AgentPool.Builder
Overrides

setBandwidthLimit(TransferTypes.AgentPool.BandwidthLimit value)

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;

Parameter
Name Description
value TransferTypes.AgentPool.BandwidthLimit
Returns
Type Description
TransferTypes.AgentPool.Builder

setBandwidthLimit(TransferTypes.AgentPool.BandwidthLimit.Builder builderForValue)

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;

Parameter
Name Description
builderForValue TransferTypes.AgentPool.BandwidthLimit.Builder
Returns
Type Description
TransferTypes.AgentPool.Builder

setDisplayName(String value)

public TransferTypes.AgentPool.Builder setDisplayName(String value)

Specifies the client-specified AgentPool description.

string display_name = 3;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
TransferTypes.AgentPool.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public TransferTypes.AgentPool.Builder setDisplayNameBytes(ByteString value)

Specifies the client-specified AgentPool description.

string display_name = 3;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
TransferTypes.AgentPool.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.AgentPool.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransferTypes.AgentPool.Builder
Overrides

setName(String value)

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];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
TransferTypes.AgentPool.Builder

This builder for chaining.

setNameBytes(ByteString value)

public TransferTypes.AgentPool.Builder setNameBytes(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];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
TransferTypes.AgentPool.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TransferTypes.AgentPool.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TransferTypes.AgentPool.Builder
Overrides

setState(TransferTypes.AgentPool.State value)

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];

Parameter
Name Description
value TransferTypes.AgentPool.State

The state to set.

Returns
Type Description
TransferTypes.AgentPool.Builder

This builder for chaining.

setStateValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
TransferTypes.AgentPool.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.AgentPool.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.AgentPool.Builder
Overrides