Class TransferTypes.AgentPool (1.46.0) 

public static final class TransferTypes.AgentPool extends GeneratedMessageV3 implements TransferTypes.AgentPoolOrBuilder

Represents an On-Premises Agent pool.

Protobuf type google.storagetransfer.v1.AgentPool

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransferTypes.AgentPool

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

getDescriptor()

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

newBuilder()

public static TransferTypes.AgentPool.Builder newBuilder()
Returns
Type Description
TransferTypes.AgentPool.Builder

newBuilder(TransferTypes.AgentPool prototype)

public static TransferTypes.AgentPool.Builder newBuilder(TransferTypes.AgentPool prototype)
Parameter
Name Description
prototype TransferTypes.AgentPool
Returns
Type Description
TransferTypes.AgentPool.Builder

parseDelimitedFrom(InputStream input)

public static TransferTypes.AgentPool parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferTypes.AgentPool
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.AgentPool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.AgentPool
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TransferTypes.AgentPool parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TransferTypes.AgentPool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.AgentPool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.AgentPool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransferTypes.AgentPool parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TransferTypes.AgentPool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.AgentPool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.AgentPool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransferTypes.AgentPool parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TransferTypes.AgentPool
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.AgentPool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.AgentPool
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TransferTypes.AgentPool parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferTypes.AgentPool
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.AgentPool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.AgentPool
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TransferTypes.AgentPool parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TransferTypes.AgentPool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.AgentPool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.AgentPool
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TransferTypes.AgentPool> parser()
Returns
Type Description
Parser<AgentPool>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

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.

getParserForType()

public Parser<TransferTypes.AgentPool> getParserForType()
Returns
Type Description
Parser<AgentPool>
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];

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TransferTypes.AgentPool.Builder newBuilderForType()
Returns
Type Description
TransferTypes.AgentPool.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferTypes.AgentPool.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TransferTypes.AgentPool.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TransferTypes.AgentPool.Builder toBuilder()
Returns
Type Description
TransferTypes.AgentPool.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException