Class ListQueuesRequest.Builder (2.21.0)

public static final class ListQueuesRequest.Builder extends GeneratedMessageV3.Builder<ListQueuesRequest.Builder> implements ListQueuesRequestOrBuilder

Request message for ListQueues.

Protobuf type google.cloud.tasks.v2.ListQueuesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListQueuesRequest build()
Returns
TypeDescription
ListQueuesRequest

buildPartial()

public ListQueuesRequest buildPartial()
Returns
TypeDescription
ListQueuesRequest

clear()

public ListQueuesRequest.Builder clear()
Returns
TypeDescription
ListQueuesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

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

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
TypeDescription
ListQueuesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

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
TypeDescription
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
TypeDescription
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
TypeDescription
ListQueuesRequest.Builder

This builder for chaining.

clone()

public ListQueuesRequest.Builder clone()
Returns
TypeDescription
ListQueuesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListQueuesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListQueuesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListQueuesRequest other)

public ListQueuesRequest.Builder mergeFrom(ListQueuesRequest other)
Parameter
NameDescription
otherListQueuesRequest
Returns
TypeDescription
ListQueuesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

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
NameDescription
valueString

The filter to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
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
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
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
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListQueuesRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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