Package com.google.cloud.tasks.v2beta3

Class ListQueuesRequest.Builder

  • All Implemented Interfaces:
    ListQueuesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ListQueuesRequest
    public static final class ListQueuesRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListQueuesRequest.Builder>
implements ListQueuesRequestOrBuilder
     Request message for
 [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues].
    Protobuf type google.cloud.tasks.v2beta3.ListQueuesRequest

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

      • clear

        public ListQueuesRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

      • getDefaultInstanceForType

        public ListQueuesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public ListQueuesRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public ListQueuesRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public ListQueuesRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

      • setField

        public ListQueuesRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

      • clearField

        public ListQueuesRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

      • clearOneof

        public ListQueuesRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

      • setRepeatedField

        public ListQueuesRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

      • addRepeatedField

        public ListQueuesRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

      • mergeFrom

        public ListQueuesRequest.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListQueuesRequest.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

      • mergeFrom

        public ListQueuesRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.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 com.google.protobuf.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​(com.google.protobuf.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 com.google.protobuf.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​(com.google.protobuf.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 com.google.protobuf.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​(com.google.protobuf.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 com.google.protobuf.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​(com.google.protobuf.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​(com.google.protobuf.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​(com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListQueuesRequest.Builder>

      • mergeUnknownFields

        public final ListQueuesRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListQueuesRequest.Builder>