Class TransferProto.ListAgentPoolsRequest.Builder (1.18.0)

public static final class TransferProto.ListAgentPoolsRequest.Builder extends GeneratedMessageV3.Builder<TransferProto.ListAgentPoolsRequest.Builder> implements TransferProto.ListAgentPoolsRequestOrBuilder

The request passed to ListAgentPools.

Protobuf type google.storagetransfer.v1.ListAgentPoolsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TransferProto.ListAgentPoolsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder
Overrides

build()

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

buildPartial()

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

clear()

public TransferProto.ListAgentPoolsRequest.Builder clear()
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public TransferProto.ListAgentPoolsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder
Overrides

clearFilter()

public TransferProto.ListAgentPoolsRequest.Builder clearFilter()

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
TransferProto.ListAgentPoolsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TransferProto.ListAgentPoolsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder
Overrides

clearPageSize()

public TransferProto.ListAgentPoolsRequest.Builder clearPageSize()

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

int32 page_size = 3;

Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

This builder for chaining.

clearPageToken()

public TransferProto.ListAgentPoolsRequest.Builder clearPageToken()

The list page token.

string page_token = 4;

Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

This builder for chaining.

clearProjectId()

public TransferProto.ListAgentPoolsRequest.Builder clearProjectId()

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

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

Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

This builder for chaining.

clone()

public TransferProto.ListAgentPoolsRequest.Builder clone()
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TransferProto.ListAgentPoolsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public TransferProto.ListAgentPoolsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder
Overrides

mergeFrom(TransferProto.ListAgentPoolsRequest other)

public TransferProto.ListAgentPoolsRequest.Builder mergeFrom(TransferProto.ListAgentPoolsRequest other)
Parameter
NameDescription
otherTransferProto.ListAgentPoolsRequest
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TransferProto.ListAgentPoolsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public TransferProto.ListAgentPoolsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder
Overrides

setFilter(String value)

public TransferProto.ListAgentPoolsRequest.Builder setFilter(String value)

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;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public TransferProto.ListAgentPoolsRequest.Builder setFilterBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

This builder for chaining.

setPageSize(int value)

public TransferProto.ListAgentPoolsRequest.Builder setPageSize(int value)

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

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

This builder for chaining.

setPageToken(String value)

public TransferProto.ListAgentPoolsRequest.Builder setPageToken(String value)

The list page token.

string page_token = 4;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public TransferProto.ListAgentPoolsRequest.Builder setPageTokenBytes(ByteString value)

The list page token.

string page_token = 4;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

This builder for chaining.

setProjectId(String value)

public TransferProto.ListAgentPoolsRequest.Builder setProjectId(String value)

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

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

Parameter
NameDescription
valueString

The projectId to set.

Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public TransferProto.ListAgentPoolsRequest.Builder setProjectIdBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for projectId to set.

Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder

This builder for chaining.

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

public TransferProto.ListAgentPoolsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final TransferProto.ListAgentPoolsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TransferProto.ListAgentPoolsRequest.Builder
Overrides