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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TransferProto.ListAgentPoolsRequest.BuilderImplements
TransferProto.ListAgentPoolsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TransferProto.ListAgentPoolsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |
build()
public TransferProto.ListAgentPoolsRequest build()
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest |
buildPartial()
public TransferProto.ListAgentPoolsRequest buildPartial()
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest |
clear()
public TransferProto.ListAgentPoolsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public TransferProto.ListAgentPoolsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |
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 | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public TransferProto.ListAgentPoolsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |
clearPageSize()
public TransferProto.ListAgentPoolsRequest.Builder clearPageSize()
The list page size. The max allowed value is 256
.
int32 page_size = 3;
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |
This builder for chaining. |
clearPageToken()
public TransferProto.ListAgentPoolsRequest.Builder clearPageToken()
The list page token.
string page_token = 4;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |
This builder for chaining. |
clone()
public TransferProto.ListAgentPoolsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |
getDefaultInstanceForType()
public TransferProto.ListAgentPoolsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ByteString |
The bytes for filter. |
getPageSize()
public int getPageSize()
The list page size. The max allowed value is 256
.
int32 page_size = 3;
Returns | |
---|---|
Type | Description |
int |
The pageSize. |
getPageToken()
public String getPageToken()
The list page token.
string page_token = 4;
Returns | |
---|---|
Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()
The list page token.
string page_token = 4;
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
ByteString |
The bytes for projectId. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TransferProto.ListAgentPoolsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public TransferProto.ListAgentPoolsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |
mergeFrom(TransferProto.ListAgentPoolsRequest other)
public TransferProto.ListAgentPoolsRequest.Builder mergeFrom(TransferProto.ListAgentPoolsRequest other)
Parameter | |
---|---|
Name | Description |
other |
TransferProto.ListAgentPoolsRequest |
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TransferProto.ListAgentPoolsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public TransferProto.ListAgentPoolsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |
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 | |
---|---|
Name | Description |
value |
String The filter to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
int The pageSize to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
String The pageToken to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
String The projectId to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value |
ByteString The bytes for projectId to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final TransferProto.ListAgentPoolsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
TransferProto.ListAgentPoolsRequest.Builder |