public static final class ListQueuesRequest.Builder extends GeneratedMessageV3.Builder<ListQueuesRequest.Builder> implements ListQueuesRequestOrBuilderRequest message for ListQueues.
Protobuf type google.cloud.tasks.v2beta3.ListQueuesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListQueuesRequest.BuilderImplements
ListQueuesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListQueuesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
build()
public ListQueuesRequest build()| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest | |
buildPartial()
public ListQueuesRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest | |
clear()
public ListQueuesRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public ListQueuesRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
clearFilter()
public ListQueuesRequest.Builder clearFilter() filter can be used to specify a subset of queues. Any
Queue field can be used as a filter and
several operators as supported. For example: <=, <, >=, >, !=, =, :. The
filter syntax is the same as described in Stackdriver's Advanced Logs
Filters.
Sample filter "state: PAUSED".
Note that using filters might cause fewer queues than the requested page_size to be returned.
string filter = 2;
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListQueuesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
clearPageSize()
public ListQueuesRequest.Builder clearPageSize()Requested page size.
The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist.
int32 page_size = 3;
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | This builder for chaining. |
clearPageToken()
public ListQueuesRequest.Builder clearPageToken()A token identifying the page of results to return.
To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.
string page_token = 4;
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | This builder for chaining. |
clearParent()
public ListQueuesRequest.Builder clearParent() Required. The location name.
For example: projects/PROJECT_ID/locations/LOCATION_ID
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | This builder for chaining. |
clearReadMask()
public ListQueuesRequest.Builder clearReadMask()Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.
.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
clone()
public ListQueuesRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
getDefaultInstanceForType()
public ListQueuesRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getFilter()
public String getFilter() filter can be used to specify a subset of queues. Any
Queue field can be used as a filter and
several operators as supported. For example: <=, <, >=, >, !=, =, :. The
filter syntax is the same as described in Stackdriver's Advanced Logs
Filters.
Sample filter "state: PAUSED".
Note that using filters might cause fewer queues than the requested page_size to be returned.
string filter = 2;
| Returns | |
|---|---|
| Type | Description |
String | The filter. |
getFilterBytes()
public ByteString getFilterBytes() filter can be used to specify a subset of queues. Any
Queue field can be used as a filter and
several operators as supported. For example: <=, <, >=, >, !=, =, :. The
filter syntax is the same as described in Stackdriver's Advanced Logs
Filters.
Sample filter "state: PAUSED".
Note that using filters might cause fewer queues than the requested page_size to be returned.
string filter = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for filter. |
getPageSize()
public int getPageSize()Requested page size.
The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist.
int32 page_size = 3;
| Returns | |
|---|---|
| Type | Description |
int | The pageSize. |
getPageToken()
public String getPageToken()A token identifying the page of results to return.
To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.
string page_token = 4;
| Returns | |
|---|---|
| Type | Description |
String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()A token identifying the page of results to return.
To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.
string page_token = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for pageToken. |
getParent()
public String getParent() Required. The location name.
For example: projects/PROJECT_ID/locations/LOCATION_ID
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The parent. |
getParentBytes()
public ByteString getParentBytes() Required. The location name.
For example: projects/PROJECT_ID/locations/LOCATION_ID
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for parent. |
getReadMask()
public FieldMask getReadMask()Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.
.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FieldMask | The readMask. |
getReadMaskBuilder()
public FieldMask.Builder getReadMaskBuilder()Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.
.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getReadMaskOrBuilder()
public FieldMaskOrBuilder getReadMaskOrBuilder()Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.
.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FieldMaskOrBuilder | |
hasReadMask()
public boolean hasReadMask()Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.
.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the readMask field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(ListQueuesRequest other)
public ListQueuesRequest.Builder mergeFrom(ListQueuesRequest other)| Parameter | |
|---|---|
| Name | Description |
other | ListQueuesRequest |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListQueuesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public ListQueuesRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
mergeReadMask(FieldMask value)
public ListQueuesRequest.Builder mergeReadMask(FieldMask value)Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.
.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | FieldMask |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListQueuesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public ListQueuesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
setFilter(String value)
public ListQueuesRequest.Builder setFilter(String value) filter can be used to specify a subset of queues. Any
Queue field can be used as a filter and
several operators as supported. For example: <=, <, >=, >, !=, =, :. The
filter syntax is the same as described in Stackdriver's Advanced Logs
Filters.
Sample filter "state: PAUSED".
Note that using filters might cause fewer queues than the requested page_size to be returned.
string filter = 2;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public ListQueuesRequest.Builder setFilterBytes(ByteString value) filter can be used to specify a subset of queues. Any
Queue field can be used as a filter and
several operators as supported. For example: <=, <, >=, >, !=, =, :. The
filter syntax is the same as described in Stackdriver's Advanced Logs
Filters.
Sample filter "state: PAUSED".
Note that using filters might cause fewer queues than the requested page_size to be returned.
string filter = 2;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | This builder for chaining. |
setPageSize(int value)
public ListQueuesRequest.Builder setPageSize(int value)Requested page size.
The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use the next_page_token in the response to determine if more queues exist.
int32 page_size = 3;
| Parameter | |
|---|---|
| Name | Description |
value | intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | This builder for chaining. |
setPageToken(String value)
public ListQueuesRequest.Builder setPageToken(String value)A token identifying the page of results to return.
To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.
string page_token = 4;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListQueuesRequest.Builder setPageTokenBytes(ByteString value)A token identifying the page of results to return.
To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.
string page_token = 4;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | This builder for chaining. |
setParent(String value)
public ListQueuesRequest.Builder setParent(String value) Required. The location name.
For example: projects/PROJECT_ID/locations/LOCATION_ID
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ListQueuesRequest.Builder setParentBytes(ByteString value) Required. The location name.
For example: projects/PROJECT_ID/locations/LOCATION_ID
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | This builder for chaining. |
setReadMask(FieldMask value)
public ListQueuesRequest.Builder setReadMask(FieldMask value)Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.
.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | FieldMask |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
setReadMask(FieldMask.Builder builderForValue)
public ListQueuesRequest.Builder setReadMask(FieldMask.Builder builderForValue)Optional. Read mask is used for a more granular control over what the API returns. If the mask is not present all fields will be returned except [Queue.stats]. [Queue.stats] will be returned only if it was explicitly specified in the mask.
.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListQueuesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListQueuesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListQueuesRequest.Builder | |