Class TransferProto.CreateAgentPoolRequest (1.23.0)

public static final class TransferProto.CreateAgentPoolRequest extends GeneratedMessageV3 implements TransferProto.CreateAgentPoolRequestOrBuilder

Specifies the request passed to CreateAgentPool.

Protobuf type google.storagetransfer.v1.CreateAgentPoolRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransferProto.CreateAgentPoolRequest

Static Fields

AGENT_POOL_FIELD_NUMBER

public static final int AGENT_POOL_FIELD_NUMBER
Field Value
Type Description
int

AGENT_POOL_ID_FIELD_NUMBER

public static final int AGENT_POOL_ID_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TransferProto.CreateAgentPoolRequest getDefaultInstance()
Returns
Type Description
TransferProto.CreateAgentPoolRequest

getDescriptor()

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

newBuilder()

public static TransferProto.CreateAgentPoolRequest.Builder newBuilder()
Returns
Type Description
TransferProto.CreateAgentPoolRequest.Builder

newBuilder(TransferProto.CreateAgentPoolRequest prototype)

public static TransferProto.CreateAgentPoolRequest.Builder newBuilder(TransferProto.CreateAgentPoolRequest prototype)
Parameter
Name Description
prototype TransferProto.CreateAgentPoolRequest
Returns
Type Description
TransferProto.CreateAgentPoolRequest.Builder

parseDelimitedFrom(InputStream input)

public static TransferProto.CreateAgentPoolRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferProto.CreateAgentPoolRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static TransferProto.CreateAgentPoolRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TransferProto.CreateAgentPoolRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static TransferProto.CreateAgentPoolRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TransferProto.CreateAgentPoolRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static TransferProto.CreateAgentPoolRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferProto.CreateAgentPoolRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static TransferProto.CreateAgentPoolRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TransferProto.CreateAgentPoolRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<TransferProto.CreateAgentPoolRequest> parser()
Returns
Type Description
Parser<CreateAgentPoolRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAgentPool()

public TransferTypes.AgentPool getAgentPool()

Required. The agent pool to create.

.google.storagetransfer.v1.AgentPool agent_pool = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransferTypes.AgentPool

The agentPool.

getAgentPoolId()

public String getAgentPoolId()

Required. The ID of the agent pool to create.

The agent_pool_id must meet the following requirements:

  • Length of 128 characters or less.
  • Not start with the string goog.
  • Start with a lowercase ASCII character, followed by:

    • Zero or more: lowercase Latin alphabet characters, numerals, hyphens (-), periods (.), underscores (_), or tildes (~).
    • One or more numerals or lowercase ASCII characters.

    As expressed by the regular expression: ^(?!goog)a-z?$.

string agent_pool_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The agentPoolId.

getAgentPoolIdBytes()

public ByteString getAgentPoolIdBytes()

Required. The ID of the agent pool to create.

The agent_pool_id must meet the following requirements:

  • Length of 128 characters or less.
  • Not start with the string goog.
  • Start with a lowercase ASCII character, followed by:

    • Zero or more: lowercase Latin alphabet characters, numerals, hyphens (-), periods (.), underscores (_), or tildes (~).
    • One or more numerals or lowercase ASCII characters.

    As expressed by the regular expression: ^(?!goog)a-z?$.

string agent_pool_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for agentPoolId.

getAgentPoolOrBuilder()

public TransferTypes.AgentPoolOrBuilder getAgentPoolOrBuilder()

Required. The agent pool to create.

.google.storagetransfer.v1.AgentPool agent_pool = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TransferTypes.AgentPoolOrBuilder

getDefaultInstanceForType()

public TransferProto.CreateAgentPoolRequest getDefaultInstanceForType()
Returns
Type Description
TransferProto.CreateAgentPoolRequest

getParserForType()

public Parser<TransferProto.CreateAgentPoolRequest> getParserForType()
Returns
Type Description
Parser<CreateAgentPoolRequest>
Overrides

getProjectId()

public String getProjectId()

Required. The ID of the Google Cloud project that owns the agent pool.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Required. The ID of the Google Cloud project that owns the agent pool.

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAgentPool()

public boolean hasAgentPool()

Required. The agent pool to create.

.google.storagetransfer.v1.AgentPool agent_pool = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the agentPool 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 TransferProto.CreateAgentPoolRequest.Builder newBuilderForType()
Returns
Type Description
TransferProto.CreateAgentPoolRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferProto.CreateAgentPoolRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TransferProto.CreateAgentPoolRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public TransferProto.CreateAgentPoolRequest.Builder toBuilder()
Returns
Type Description
TransferProto.CreateAgentPoolRequest.Builder

writeTo(CodedOutputStream output)

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