Class TransferProto.ListAgentPoolsRequest (1.41.0)

public static final class TransferProto.ListAgentPoolsRequest extends GeneratedMessageV3 implements TransferProto.ListAgentPoolsRequestOrBuilder

The request passed to ListAgentPools.

Protobuf type google.storagetransfer.v1.ListAgentPoolsRequest

Inheritance

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

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TransferProto.ListAgentPoolsRequest getDefaultInstance()
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TransferProto.ListAgentPoolsRequest.Builder newBuilder()
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

newBuilder(TransferProto.ListAgentPoolsRequest prototype)

public static TransferProto.ListAgentPoolsRequest.Builder newBuilder(TransferProto.ListAgentPoolsRequest prototype)
Parameter
NameDescription
prototypeTransferProto.ListAgentPoolsRequest
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

parseDelimitedFrom(InputStream input)

public static TransferProto.ListAgentPoolsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferProto.ListAgentPoolsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TransferProto.ListAgentPoolsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferProto.ListAgentPoolsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransferProto.ListAgentPoolsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferProto.ListAgentPoolsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransferProto.ListAgentPoolsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferProto.ListAgentPoolsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TransferProto.ListAgentPoolsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferProto.ListAgentPoolsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TransferProto.ListAgentPoolsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferProto.ListAgentPoolsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TransferProto.ListAgentPoolsRequest> parser()
Returns
TypeDescription
Parser<ListAgentPoolsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public TransferProto.ListAgentPoolsRequest getDefaultInstanceForType()
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest

getFilter()

public String getFilter()

An optional list of query parameters specified as JSON text in the form of:

{"agentPoolNames":["agentpool1","agentpool2",...]}

Since agentPoolNames support multiple values, its values must be specified with array notation. When the filter is either empty or not provided, the list returns all agent pools for the project.

string filter = 2;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

An optional list of query parameters specified as JSON text in the form of:

{"agentPoolNames":["agentpool1","agentpool2",...]}

Since agentPoolNames support multiple values, its values must be specified with array notation. When the filter is either empty or not provided, the list returns all agent pools for the project.

string filter = 2;

Returns
TypeDescription
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

The list page size. The max allowed value is 256.

int32 page_size = 3;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

The list page token.

string page_token = 4;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The list page token.

string page_token = 4;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParserForType()

public Parser<TransferProto.ListAgentPoolsRequest> getParserForType()
Returns
TypeDescription
Parser<ListAgentPoolsRequest>
Overrides

getProjectId()

public String getProjectId()

Required. The ID of the Google Cloud project that owns the job.

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

Returns
TypeDescription
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

Required. The ID of the Google Cloud project that owns the job.

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

Returns
TypeDescription
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TransferProto.ListAgentPoolsRequest.Builder newBuilderForType()
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferProto.ListAgentPoolsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TransferProto.ListAgentPoolsRequest.Builder toBuilder()
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException