com.google.cloud.tasks.v2beta3

Class ListQueuesRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

com.google.cloud.tasks.v2beta3.ListQueuesRequest.Builder

All Implemented Interfaces:

ListQueuesRequestOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable

Enclosing class:

ListQueuesRequest

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

 Request message for [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues].
 

Protobuf type google.cloud.tasks.v2beta3.ListQueuesRequest

Method Summary

Modifier and Type	Method and Description
ListQueuesRequest.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value)
ListQueuesRequest	build()
ListQueuesRequest	buildPartial()
ListQueuesRequest.Builder	clear()
ListQueuesRequest.Builder	clearField(Descriptors.FieldDescriptor field)
ListQueuesRequest.Builder	clearFilter() `filter` can be used to specify a subset of queues.
ListQueuesRequest.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
ListQueuesRequest.Builder	clearPageSize() Requested page size.
ListQueuesRequest.Builder	clearPageToken() A token identifying the page of results to return.
ListQueuesRequest.Builder	clearParent() Required.
ListQueuesRequest.Builder	clearReadMask() Optional.
ListQueuesRequest.Builder	clone()
ListQueuesRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
String	getFilter() `filter` can be used to specify a subset of queues.
ByteString	getFilterBytes() `filter` can be used to specify a subset of queues.
int	getPageSize() Requested page size.
String	getPageToken() A token identifying the page of results to return.
ByteString	getPageTokenBytes() A token identifying the page of results to return.
String	getParent() Required.
ByteString	getParentBytes() Required.
FieldMask	getReadMask() Optional.
FieldMask.Builder	getReadMaskBuilder() Optional.
FieldMaskOrBuilder	getReadMaskOrBuilder() Optional.
boolean	hasReadMask() Optional.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ListQueuesRequest.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
ListQueuesRequest.Builder	mergeFrom(ListQueuesRequest other)
ListQueuesRequest.Builder	mergeFrom(Message other)
ListQueuesRequest.Builder	mergeReadMask(FieldMask value) Optional.
ListQueuesRequest.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
ListQueuesRequest.Builder	setField(Descriptors.FieldDescriptor field, Object value)
ListQueuesRequest.Builder	setFilter(String value) `filter` can be used to specify a subset of queues.
ListQueuesRequest.Builder	setFilterBytes(ByteString value) `filter` can be used to specify a subset of queues.
ListQueuesRequest.Builder	setPageSize(int value) Requested page size.
ListQueuesRequest.Builder	setPageToken(String value) A token identifying the page of results to return.
ListQueuesRequest.Builder	setPageTokenBytes(ByteString value) A token identifying the page of results to return.
ListQueuesRequest.Builder	setParent(String value) Required.
ListQueuesRequest.Builder	setParentBytes(ByteString value) Required.
ListQueuesRequest.Builder	setReadMask(FieldMask.Builder builderForValue) Optional.
ListQueuesRequest.Builder	setReadMask(FieldMask value) Optional.
ListQueuesRequest.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
ListQueuesRequest.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

clear

public ListQueuesRequest.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

getDefaultInstanceForType

public ListQueuesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public ListQueuesRequest build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public ListQueuesRequest buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public ListQueuesRequest.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

setField

public ListQueuesRequest.Builder setField(Descriptors.FieldDescriptor field,
                                          Object value)

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

clearField

public ListQueuesRequest.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

clearOneof

public ListQueuesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

addRepeatedField

public ListQueuesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                                  Object value)

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

mergeFrom

public ListQueuesRequest.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<ListQueuesRequest.Builder>

mergeFrom

public ListQueuesRequest.Builder mergeFrom(ListQueuesRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

mergeFrom

public ListQueuesRequest.Builder mergeFrom(CodedInputStream input,
                                           ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<ListQueuesRequest.Builder>

Throws:

IOException

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) = { ... }

Specified by:

getParent in interface ListQueuesRequestOrBuilder

Returns:

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) = { ... }

Specified by:

getParentBytes in interface ListQueuesRequestOrBuilder

Returns:

The bytes for parent.

setParent

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) = { ... }

Parameters:

value - The parent to set.

Returns:

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:

This builder for chaining.

setParentBytes

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) = { ... }

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

getFilter

public String getFilter()

 `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta3.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](https://cloud.google.com/logging/docs/view/advanced_filters).
 Sample filter "state: PAUSED".
 Note that using filters might cause fewer queues than the
 requested page_size to be returned.
 

string filter = 2;

Specified by:

getFilter in interface ListQueuesRequestOrBuilder

Returns:

The filter.

getFilterBytes

public ByteString getFilterBytes()

 `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta3.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](https://cloud.google.com/logging/docs/view/advanced_filters).
 Sample filter "state: PAUSED".
 Note that using filters might cause fewer queues than the
 requested page_size to be returned.
 

string filter = 2;

Specified by:

getFilterBytes in interface ListQueuesRequestOrBuilder

Returns:

The bytes for filter.

setFilter

public ListQueuesRequest.Builder setFilter(String value)

 `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta3.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](https://cloud.google.com/logging/docs/view/advanced_filters).
 Sample filter "state: PAUSED".
 Note that using filters might cause fewer queues than the
 requested page_size to be returned.
 

string filter = 2;

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public ListQueuesRequest.Builder clearFilter()

 `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta3.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](https://cloud.google.com/logging/docs/view/advanced_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:

This builder for chaining.

setFilterBytes

public ListQueuesRequest.Builder setFilterBytes(ByteString value)

 `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta3.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](https://cloud.google.com/logging/docs/view/advanced_filters).
 Sample filter "state: PAUSED".
 Note that using filters might cause fewer queues than the
 requested page_size to be returned.
 

string filter = 2;

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

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][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] in the
 response to determine if more queues exist.
 

int32 page_size = 3;

Specified by:

getPageSize in interface ListQueuesRequestOrBuilder

Returns:

The pageSize.

setPageSize

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][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] in the
 response to determine if more queues exist.
 

int32 page_size = 3;

Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

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][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] in the
 response to determine if more queues exist.
 

int32 page_size = 3;

Returns:

This builder for chaining.

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][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] returned
 from the previous call to [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues]
 method. It is an error to switch the value of the
 [filter][google.cloud.tasks.v2beta3.ListQueuesRequest.filter] while iterating through pages.
 

string page_token = 4;

Specified by:

getPageToken in interface ListQueuesRequestOrBuilder

Returns:

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][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] returned
 from the previous call to [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues]
 method. It is an error to switch the value of the
 [filter][google.cloud.tasks.v2beta3.ListQueuesRequest.filter] while iterating through pages.
 

string page_token = 4;

Specified by:

getPageTokenBytes in interface ListQueuesRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

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][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] returned
 from the previous call to [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues]
 method. It is an error to switch the value of the
 [filter][google.cloud.tasks.v2beta3.ListQueuesRequest.filter] while iterating through pages.
 

string page_token = 4;

Parameters:

value - The pageToken to set.

Returns:

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][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] returned
 from the previous call to [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues]
 method. It is an error to switch the value of the
 [filter][google.cloud.tasks.v2beta3.ListQueuesRequest.filter] while iterating through pages.
 

string page_token = 4;

Returns:

This builder for chaining.

setPageTokenBytes

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][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] returned
 from the previous call to [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues]
 method. It is an error to switch the value of the
 [filter][google.cloud.tasks.v2beta3.ListQueuesRequest.filter] while iterating through pages.
 

string page_token = 4;

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

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];

Specified by:

hasReadMask in interface ListQueuesRequestOrBuilder

Returns:

Whether the readMask field is set.

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];

Specified by:

getReadMask in interface ListQueuesRequestOrBuilder

Returns:

The readMask.

setReadMask

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];

setReadMask

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];

mergeReadMask

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];

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];

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];

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];

Specified by:

getReadMaskOrBuilder in interface ListQueuesRequestOrBuilder

setUnknownFields

public final ListQueuesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

mergeUnknownFields

public final ListQueuesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<ListQueuesRequest.Builder>