Package com.google.cloud.tasks.v2

Class Queue.Builder

  • All Implemented Interfaces:
    QueueOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Queue
    public static final class Queue.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Queue.Builder>
implements QueueOrBuilder
     A queue is a container of related tasks. Queues are configured to manage
 how those tasks are dispatched. Configurable properties include rate limits,
 retry options, queue types, and others.
    Protobuf type google.cloud.tasks.v2.Queue

    • 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<Queue.Builder>

      • clear

        public Queue.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<Queue.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<Queue.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Queue.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<Queue.Builder>

      • setField

        public Queue.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<Queue.Builder>

      • clearField

        public Queue.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<Queue.Builder>

      • clearOneof

        public Queue.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<Queue.Builder>

      • setRepeatedField

        public Queue.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<Queue.Builder>

      • addRepeatedField

        public Queue.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<Queue.Builder>

      • mergeFrom

        public Queue.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<Queue.Builder>

      • isInitialized

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

      • mergeFrom

        public Queue.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<Queue.Builder>
        Throws:
        IOException

      • getName

        public String getName()
         Caller-specified and required in
 [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue], after which it
 becomes output only.

 The queue name.

 The queue name must have the following format:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`

 * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
    hyphens (-), colons (:), or periods (.).
    For more information, see
    [Identifying
    projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
 * `LOCATION_ID` is the canonical ID for the queue's location.
    The list of available locations can be obtained by calling
    [ListLocations][google.cloud.location.Locations.ListLocations].
    For more information, see https://cloud.google.com/about/locations/.
 * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
   hyphens (-). The maximum length is 100 characters.
        string name = 1;
        Specified by:
        getName in interface QueueOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Caller-specified and required in
 [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue], after which it
 becomes output only.

 The queue name.

 The queue name must have the following format:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`

 * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
    hyphens (-), colons (:), or periods (.).
    For more information, see
    [Identifying
    projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
 * `LOCATION_ID` is the canonical ID for the queue's location.
    The list of available locations can be obtained by calling
    [ListLocations][google.cloud.location.Locations.ListLocations].
    For more information, see https://cloud.google.com/about/locations/.
 * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
   hyphens (-). The maximum length is 100 characters.
        string name = 1;
        Specified by:
        getNameBytes in interface QueueOrBuilder
        Returns:
        The bytes for name.

      • setName

        public Queue.Builder setName​(String value)
         Caller-specified and required in
 [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue], after which it
 becomes output only.

 The queue name.

 The queue name must have the following format:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`

 * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
    hyphens (-), colons (:), or periods (.).
    For more information, see
    [Identifying
    projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
 * `LOCATION_ID` is the canonical ID for the queue's location.
    The list of available locations can be obtained by calling
    [ListLocations][google.cloud.location.Locations.ListLocations].
    For more information, see https://cloud.google.com/about/locations/.
 * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
   hyphens (-). The maximum length is 100 characters.
        string name = 1;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public Queue.Builder clearName()
         Caller-specified and required in
 [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue], after which it
 becomes output only.

 The queue name.

 The queue name must have the following format:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`

 * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
    hyphens (-), colons (:), or periods (.).
    For more information, see
    [Identifying
    projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
 * `LOCATION_ID` is the canonical ID for the queue's location.
    The list of available locations can be obtained by calling
    [ListLocations][google.cloud.location.Locations.ListLocations].
    For more information, see https://cloud.google.com/about/locations/.
 * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
   hyphens (-). The maximum length is 100 characters.
        string name = 1;
        Returns:
        This builder for chaining.

      • setNameBytes

        public Queue.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Caller-specified and required in
 [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue], after which it
 becomes output only.

 The queue name.

 The queue name must have the following format:
 `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`

 * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
    hyphens (-), colons (:), or periods (.).
    For more information, see
    [Identifying
    projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
 * `LOCATION_ID` is the canonical ID for the queue's location.
    The list of available locations can be obtained by calling
    [ListLocations][google.cloud.location.Locations.ListLocations].
    For more information, see https://cloud.google.com/about/locations/.
 * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
   hyphens (-). The maximum length is 100 characters.
        string name = 1;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • hasAppEngineRoutingOverride

        public boolean hasAppEngineRoutingOverride()
         Overrides for
 [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
 These settings apply only to
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this
 queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected.

 If set, `app_engine_routing_override` is used for all
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the
 queue, no matter what the setting is for the [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;
        Specified by:
        hasAppEngineRoutingOverride in interface QueueOrBuilder
        Returns:
        Whether the appEngineRoutingOverride field is set.

      • getAppEngineRoutingOverride

        public AppEngineRouting getAppEngineRoutingOverride()
         Overrides for
 [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
 These settings apply only to
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this
 queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected.

 If set, `app_engine_routing_override` is used for all
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the
 queue, no matter what the setting is for the [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;
        Specified by:
        getAppEngineRoutingOverride in interface QueueOrBuilder
        Returns:
        The appEngineRoutingOverride.

      • setAppEngineRoutingOverride

        public Queue.Builder setAppEngineRoutingOverride​(AppEngineRouting value)
         Overrides for
 [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
 These settings apply only to
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this
 queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected.

 If set, `app_engine_routing_override` is used for all
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the
 queue, no matter what the setting is for the [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;

      • setAppEngineRoutingOverride

        public Queue.Builder setAppEngineRoutingOverride​(AppEngineRouting.Builder builderForValue)
         Overrides for
 [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
 These settings apply only to
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this
 queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected.

 If set, `app_engine_routing_override` is used for all
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the
 queue, no matter what the setting is for the [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;

      • mergeAppEngineRoutingOverride

        public Queue.Builder mergeAppEngineRoutingOverride​(AppEngineRouting value)
         Overrides for
 [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
 These settings apply only to
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this
 queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected.

 If set, `app_engine_routing_override` is used for all
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the
 queue, no matter what the setting is for the [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;

      • clearAppEngineRoutingOverride

        public Queue.Builder clearAppEngineRoutingOverride()
         Overrides for
 [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
 These settings apply only to
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this
 queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected.

 If set, `app_engine_routing_override` is used for all
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the
 queue, no matter what the setting is for the [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;

      • getAppEngineRoutingOverrideBuilder

        public AppEngineRouting.Builder getAppEngineRoutingOverrideBuilder()
         Overrides for
 [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
 These settings apply only to
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this
 queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected.

 If set, `app_engine_routing_override` is used for all
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the
 queue, no matter what the setting is for the [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;

      • getAppEngineRoutingOverrideOrBuilder

        public AppEngineRoutingOrBuilder getAppEngineRoutingOverrideOrBuilder()
         Overrides for
 [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
 These settings apply only to
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this
 queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected.

 If set, `app_engine_routing_override` is used for all
 [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the
 queue, no matter what the setting is for the [task-level
 app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
        .google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;
        Specified by:
        getAppEngineRoutingOverrideOrBuilder in interface QueueOrBuilder

      • hasRateLimits

        public boolean hasRateLimits()
         Rate limits for task dispatches.

 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and
 [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related
 because they both control task attempts. However they control task attempts
 in different ways:

 * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] controls the total
 rate of
   dispatches from a queue (i.e. all traffic dispatched from the
   queue, regardless of whether the dispatch is from a first
   attempt or a retry).
 * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls what
 happens to
   particular a task after its first attempt fails. That is,
   [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls task
   retries (the second attempt, third attempt, etc).

 The queue's actual dispatch rate is the result of:

 * Number of tasks in the queue
 * User-specified throttling:
 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits],
   [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the
   [queue's state][google.cloud.tasks.v2.Queue.state].
 * System throttling due to `429` (Too Many Requests) or `503` (Service
   Unavailable) responses from the worker, high error rates, or to smooth
   sudden large traffic spikes.
        .google.cloud.tasks.v2.RateLimits rate_limits = 3;
        Specified by:
        hasRateLimits in interface QueueOrBuilder
        Returns:
        Whether the rateLimits field is set.

      • getRateLimits

        public RateLimits getRateLimits()
         Rate limits for task dispatches.

 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and
 [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related
 because they both control task attempts. However they control task attempts
 in different ways:

 * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] controls the total
 rate of
   dispatches from a queue (i.e. all traffic dispatched from the
   queue, regardless of whether the dispatch is from a first
   attempt or a retry).
 * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls what
 happens to
   particular a task after its first attempt fails. That is,
   [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls task
   retries (the second attempt, third attempt, etc).

 The queue's actual dispatch rate is the result of:

 * Number of tasks in the queue
 * User-specified throttling:
 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits],
   [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the
   [queue's state][google.cloud.tasks.v2.Queue.state].
 * System throttling due to `429` (Too Many Requests) or `503` (Service
   Unavailable) responses from the worker, high error rates, or to smooth
   sudden large traffic spikes.
        .google.cloud.tasks.v2.RateLimits rate_limits = 3;
        Specified by:
        getRateLimits in interface QueueOrBuilder
        Returns:
        The rateLimits.

      • setRateLimits

        public Queue.Builder setRateLimits​(RateLimits value)
         Rate limits for task dispatches.

 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and
 [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related
 because they both control task attempts. However they control task attempts
 in different ways:

 * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] controls the total
 rate of
   dispatches from a queue (i.e. all traffic dispatched from the
   queue, regardless of whether the dispatch is from a first
   attempt or a retry).
 * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls what
 happens to
   particular a task after its first attempt fails. That is,
   [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls task
   retries (the second attempt, third attempt, etc).

 The queue's actual dispatch rate is the result of:

 * Number of tasks in the queue
 * User-specified throttling:
 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits],
   [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the
   [queue's state][google.cloud.tasks.v2.Queue.state].
 * System throttling due to `429` (Too Many Requests) or `503` (Service
   Unavailable) responses from the worker, high error rates, or to smooth
   sudden large traffic spikes.
        .google.cloud.tasks.v2.RateLimits rate_limits = 3;

      • setRateLimits

        public Queue.Builder setRateLimits​(RateLimits.Builder builderForValue)
         Rate limits for task dispatches.

 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and
 [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related
 because they both control task attempts. However they control task attempts
 in different ways:

 * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] controls the total
 rate of
   dispatches from a queue (i.e. all traffic dispatched from the
   queue, regardless of whether the dispatch is from a first
   attempt or a retry).
 * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls what
 happens to
   particular a task after its first attempt fails. That is,
   [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls task
   retries (the second attempt, third attempt, etc).

 The queue's actual dispatch rate is the result of:

 * Number of tasks in the queue
 * User-specified throttling:
 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits],
   [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the
   [queue's state][google.cloud.tasks.v2.Queue.state].
 * System throttling due to `429` (Too Many Requests) or `503` (Service
   Unavailable) responses from the worker, high error rates, or to smooth
   sudden large traffic spikes.
        .google.cloud.tasks.v2.RateLimits rate_limits = 3;

      • mergeRateLimits

        public Queue.Builder mergeRateLimits​(RateLimits value)
         Rate limits for task dispatches.

 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and
 [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related
 because they both control task attempts. However they control task attempts
 in different ways:

 * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] controls the total
 rate of
   dispatches from a queue (i.e. all traffic dispatched from the
   queue, regardless of whether the dispatch is from a first
   attempt or a retry).
 * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls what
 happens to
   particular a task after its first attempt fails. That is,
   [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls task
   retries (the second attempt, third attempt, etc).

 The queue's actual dispatch rate is the result of:

 * Number of tasks in the queue
 * User-specified throttling:
 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits],
   [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the
   [queue's state][google.cloud.tasks.v2.Queue.state].
 * System throttling due to `429` (Too Many Requests) or `503` (Service
   Unavailable) responses from the worker, high error rates, or to smooth
   sudden large traffic spikes.
        .google.cloud.tasks.v2.RateLimits rate_limits = 3;

      • clearRateLimits

        public Queue.Builder clearRateLimits()
         Rate limits for task dispatches.

 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and
 [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related
 because they both control task attempts. However they control task attempts
 in different ways:

 * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] controls the total
 rate of
   dispatches from a queue (i.e. all traffic dispatched from the
   queue, regardless of whether the dispatch is from a first
   attempt or a retry).
 * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls what
 happens to
   particular a task after its first attempt fails. That is,
   [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls task
   retries (the second attempt, third attempt, etc).

 The queue's actual dispatch rate is the result of:

 * Number of tasks in the queue
 * User-specified throttling:
 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits],
   [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the
   [queue's state][google.cloud.tasks.v2.Queue.state].
 * System throttling due to `429` (Too Many Requests) or `503` (Service
   Unavailable) responses from the worker, high error rates, or to smooth
   sudden large traffic spikes.
        .google.cloud.tasks.v2.RateLimits rate_limits = 3;

      • getRateLimitsBuilder

        public RateLimits.Builder getRateLimitsBuilder()
         Rate limits for task dispatches.

 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and
 [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related
 because they both control task attempts. However they control task attempts
 in different ways:

 * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] controls the total
 rate of
   dispatches from a queue (i.e. all traffic dispatched from the
   queue, regardless of whether the dispatch is from a first
   attempt or a retry).
 * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls what
 happens to
   particular a task after its first attempt fails. That is,
   [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls task
   retries (the second attempt, third attempt, etc).

 The queue's actual dispatch rate is the result of:

 * Number of tasks in the queue
 * User-specified throttling:
 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits],
   [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the
   [queue's state][google.cloud.tasks.v2.Queue.state].
 * System throttling due to `429` (Too Many Requests) or `503` (Service
   Unavailable) responses from the worker, high error rates, or to smooth
   sudden large traffic spikes.
        .google.cloud.tasks.v2.RateLimits rate_limits = 3;

      • getRateLimitsOrBuilder

        public RateLimitsOrBuilder getRateLimitsOrBuilder()
         Rate limits for task dispatches.

 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and
 [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related
 because they both control task attempts. However they control task attempts
 in different ways:

 * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] controls the total
 rate of
   dispatches from a queue (i.e. all traffic dispatched from the
   queue, regardless of whether the dispatch is from a first
   attempt or a retry).
 * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls what
 happens to
   particular a task after its first attempt fails. That is,
   [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls task
   retries (the second attempt, third attempt, etc).

 The queue's actual dispatch rate is the result of:

 * Number of tasks in the queue
 * User-specified throttling:
 [rate_limits][google.cloud.tasks.v2.Queue.rate_limits],
   [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the
   [queue's state][google.cloud.tasks.v2.Queue.state].
 * System throttling due to `429` (Too Many Requests) or `503` (Service
   Unavailable) responses from the worker, high error rates, or to smooth
   sudden large traffic spikes.
        .google.cloud.tasks.v2.RateLimits rate_limits = 3;
        Specified by:
        getRateLimitsOrBuilder in interface QueueOrBuilder

      • hasRetryConfig

        public boolean hasRetryConfig()
         Settings that determine the retry behavior.

 * For tasks created using Cloud Tasks: the queue-level retry settings
   apply to all tasks in the queue that were created using Cloud Tasks.
   Retry settings cannot be set on individual tasks.
 * For tasks created using the App Engine SDK: the queue-level retry
   settings apply to all tasks in the queue which do not have retry settings
   explicitly set on the task and were created by the App Engine SDK. See
   [App Engine
   documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
        .google.cloud.tasks.v2.RetryConfig retry_config = 4;
        Specified by:
        hasRetryConfig in interface QueueOrBuilder
        Returns:
        Whether the retryConfig field is set.

      • getRetryConfig

        public RetryConfig getRetryConfig()
         Settings that determine the retry behavior.

 * For tasks created using Cloud Tasks: the queue-level retry settings
   apply to all tasks in the queue that were created using Cloud Tasks.
   Retry settings cannot be set on individual tasks.
 * For tasks created using the App Engine SDK: the queue-level retry
   settings apply to all tasks in the queue which do not have retry settings
   explicitly set on the task and were created by the App Engine SDK. See
   [App Engine
   documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
        .google.cloud.tasks.v2.RetryConfig retry_config = 4;
        Specified by:
        getRetryConfig in interface QueueOrBuilder
        Returns:
        The retryConfig.

      • setRetryConfig

        public Queue.Builder setRetryConfig​(RetryConfig value)
         Settings that determine the retry behavior.

 * For tasks created using Cloud Tasks: the queue-level retry settings
   apply to all tasks in the queue that were created using Cloud Tasks.
   Retry settings cannot be set on individual tasks.
 * For tasks created using the App Engine SDK: the queue-level retry
   settings apply to all tasks in the queue which do not have retry settings
   explicitly set on the task and were created by the App Engine SDK. See
   [App Engine
   documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
        .google.cloud.tasks.v2.RetryConfig retry_config = 4;

      • setRetryConfig

        public Queue.Builder setRetryConfig​(RetryConfig.Builder builderForValue)
         Settings that determine the retry behavior.

 * For tasks created using Cloud Tasks: the queue-level retry settings
   apply to all tasks in the queue that were created using Cloud Tasks.
   Retry settings cannot be set on individual tasks.
 * For tasks created using the App Engine SDK: the queue-level retry
   settings apply to all tasks in the queue which do not have retry settings
   explicitly set on the task and were created by the App Engine SDK. See
   [App Engine
   documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
        .google.cloud.tasks.v2.RetryConfig retry_config = 4;

      • mergeRetryConfig

        public Queue.Builder mergeRetryConfig​(RetryConfig value)
         Settings that determine the retry behavior.

 * For tasks created using Cloud Tasks: the queue-level retry settings
   apply to all tasks in the queue that were created using Cloud Tasks.
   Retry settings cannot be set on individual tasks.
 * For tasks created using the App Engine SDK: the queue-level retry
   settings apply to all tasks in the queue which do not have retry settings
   explicitly set on the task and were created by the App Engine SDK. See
   [App Engine
   documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
        .google.cloud.tasks.v2.RetryConfig retry_config = 4;

      • clearRetryConfig

        public Queue.Builder clearRetryConfig()
         Settings that determine the retry behavior.

 * For tasks created using Cloud Tasks: the queue-level retry settings
   apply to all tasks in the queue that were created using Cloud Tasks.
   Retry settings cannot be set on individual tasks.
 * For tasks created using the App Engine SDK: the queue-level retry
   settings apply to all tasks in the queue which do not have retry settings
   explicitly set on the task and were created by the App Engine SDK. See
   [App Engine
   documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
        .google.cloud.tasks.v2.RetryConfig retry_config = 4;

      • getRetryConfigBuilder

        public RetryConfig.Builder getRetryConfigBuilder()
         Settings that determine the retry behavior.

 * For tasks created using Cloud Tasks: the queue-level retry settings
   apply to all tasks in the queue that were created using Cloud Tasks.
   Retry settings cannot be set on individual tasks.
 * For tasks created using the App Engine SDK: the queue-level retry
   settings apply to all tasks in the queue which do not have retry settings
   explicitly set on the task and were created by the App Engine SDK. See
   [App Engine
   documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
        .google.cloud.tasks.v2.RetryConfig retry_config = 4;

      • getRetryConfigOrBuilder

        public RetryConfigOrBuilder getRetryConfigOrBuilder()
         Settings that determine the retry behavior.

 * For tasks created using Cloud Tasks: the queue-level retry settings
   apply to all tasks in the queue that were created using Cloud Tasks.
   Retry settings cannot be set on individual tasks.
 * For tasks created using the App Engine SDK: the queue-level retry
   settings apply to all tasks in the queue which do not have retry settings
   explicitly set on the task and were created by the App Engine SDK. See
   [App Engine
   documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
        .google.cloud.tasks.v2.RetryConfig retry_config = 4;
        Specified by:
        getRetryConfigOrBuilder in interface QueueOrBuilder

      • getStateValue

        public int getStateValue()
         Output only. The state of the queue.

 `state` can only be changed by calling
 [PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue],
 [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue], or uploading
 [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
 [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] cannot be used
 to change `state`.
        .google.cloud.tasks.v2.Queue.State state = 5;
        Specified by:
        getStateValue in interface QueueOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • setStateValue

        public Queue.Builder setStateValue​(int value)
         Output only. The state of the queue.

 `state` can only be changed by calling
 [PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue],
 [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue], or uploading
 [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
 [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] cannot be used
 to change `state`.
        .google.cloud.tasks.v2.Queue.State state = 5;
        Parameters:
        value - The enum numeric value on the wire for state to set.
        Returns:
        This builder for chaining.

      • getState

        public Queue.State getState()
         Output only. The state of the queue.

 `state` can only be changed by calling
 [PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue],
 [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue], or uploading
 [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
 [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] cannot be used
 to change `state`.
        .google.cloud.tasks.v2.Queue.State state = 5;
        Specified by:
        getState in interface QueueOrBuilder
        Returns:
        The state.

      • setState

        public Queue.Builder setState​(Queue.State value)
         Output only. The state of the queue.

 `state` can only be changed by calling
 [PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue],
 [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue], or uploading
 [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
 [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] cannot be used
 to change `state`.
        .google.cloud.tasks.v2.Queue.State state = 5;
        Parameters:
        value - The state to set.
        Returns:
        This builder for chaining.

      • clearState

        public Queue.Builder clearState()
         Output only. The state of the queue.

 `state` can only be changed by calling
 [PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue],
 [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue], or uploading
 [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
 [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] cannot be used
 to change `state`.
        .google.cloud.tasks.v2.Queue.State state = 5;
        Returns:
        This builder for chaining.

      • hasPurgeTime

        public boolean hasPurgeTime()
         Output only. The last time this queue was purged.

 All tasks that were [created][google.cloud.tasks.v2.Task.create_time]
 before this time were purged.

 A queue can be purged using
 [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue], the [App Engine
 Task Queue SDK, or the Cloud
 Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).

 Purge time will be truncated to the nearest microsecond. Purge
 time will be unset if the queue has never been purged.
        .google.protobuf.Timestamp purge_time = 6;
        Specified by:
        hasPurgeTime in interface QueueOrBuilder
        Returns:
        Whether the purgeTime field is set.

      • getPurgeTime

        public com.google.protobuf.Timestamp getPurgeTime()
         Output only. The last time this queue was purged.

 All tasks that were [created][google.cloud.tasks.v2.Task.create_time]
 before this time were purged.

 A queue can be purged using
 [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue], the [App Engine
 Task Queue SDK, or the Cloud
 Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).

 Purge time will be truncated to the nearest microsecond. Purge
 time will be unset if the queue has never been purged.
        .google.protobuf.Timestamp purge_time = 6;
        Specified by:
        getPurgeTime in interface QueueOrBuilder
        Returns:
        The purgeTime.

      • setPurgeTime

        public Queue.Builder setPurgeTime​(com.google.protobuf.Timestamp value)
         Output only. The last time this queue was purged.

 All tasks that were [created][google.cloud.tasks.v2.Task.create_time]
 before this time were purged.

 A queue can be purged using
 [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue], the [App Engine
 Task Queue SDK, or the Cloud
 Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).

 Purge time will be truncated to the nearest microsecond. Purge
 time will be unset if the queue has never been purged.
        .google.protobuf.Timestamp purge_time = 6;

      • setPurgeTime

        public Queue.Builder setPurgeTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. The last time this queue was purged.

 All tasks that were [created][google.cloud.tasks.v2.Task.create_time]
 before this time were purged.

 A queue can be purged using
 [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue], the [App Engine
 Task Queue SDK, or the Cloud
 Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).

 Purge time will be truncated to the nearest microsecond. Purge
 time will be unset if the queue has never been purged.
        .google.protobuf.Timestamp purge_time = 6;

      • mergePurgeTime

        public Queue.Builder mergePurgeTime​(com.google.protobuf.Timestamp value)
         Output only. The last time this queue was purged.

 All tasks that were [created][google.cloud.tasks.v2.Task.create_time]
 before this time were purged.

 A queue can be purged using
 [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue], the [App Engine
 Task Queue SDK, or the Cloud
 Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).

 Purge time will be truncated to the nearest microsecond. Purge
 time will be unset if the queue has never been purged.
        .google.protobuf.Timestamp purge_time = 6;

      • clearPurgeTime

        public Queue.Builder clearPurgeTime()
         Output only. The last time this queue was purged.

 All tasks that were [created][google.cloud.tasks.v2.Task.create_time]
 before this time were purged.

 A queue can be purged using
 [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue], the [App Engine
 Task Queue SDK, or the Cloud
 Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).

 Purge time will be truncated to the nearest microsecond. Purge
 time will be unset if the queue has never been purged.
        .google.protobuf.Timestamp purge_time = 6;

      • getPurgeTimeBuilder

        public com.google.protobuf.Timestamp.Builder getPurgeTimeBuilder()
         Output only. The last time this queue was purged.

 All tasks that were [created][google.cloud.tasks.v2.Task.create_time]
 before this time were purged.

 A queue can be purged using
 [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue], the [App Engine
 Task Queue SDK, or the Cloud
 Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).

 Purge time will be truncated to the nearest microsecond. Purge
 time will be unset if the queue has never been purged.
        .google.protobuf.Timestamp purge_time = 6;

      • getPurgeTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getPurgeTimeOrBuilder()
         Output only. The last time this queue was purged.

 All tasks that were [created][google.cloud.tasks.v2.Task.create_time]
 before this time were purged.

 A queue can be purged using
 [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue], the [App Engine
 Task Queue SDK, or the Cloud
 Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).

 Purge time will be truncated to the nearest microsecond. Purge
 time will be unset if the queue has never been purged.
        .google.protobuf.Timestamp purge_time = 6;
        Specified by:
        getPurgeTimeOrBuilder in interface QueueOrBuilder

      • hasStackdriverLoggingConfig

        public boolean hasStackdriverLoggingConfig()
         Configuration options for writing logs to
 [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
 field is unset, then no logs are written.
        .google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;
        Specified by:
        hasStackdriverLoggingConfig in interface QueueOrBuilder
        Returns:
        Whether the stackdriverLoggingConfig field is set.

      • getStackdriverLoggingConfig

        public StackdriverLoggingConfig getStackdriverLoggingConfig()
         Configuration options for writing logs to
 [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
 field is unset, then no logs are written.
        .google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;
        Specified by:
        getStackdriverLoggingConfig in interface QueueOrBuilder
        Returns:
        The stackdriverLoggingConfig.

      • setStackdriverLoggingConfig

        public Queue.Builder setStackdriverLoggingConfig​(StackdriverLoggingConfig value)
         Configuration options for writing logs to
 [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
 field is unset, then no logs are written.
        .google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;

      • setStackdriverLoggingConfig

        public Queue.Builder setStackdriverLoggingConfig​(StackdriverLoggingConfig.Builder builderForValue)
         Configuration options for writing logs to
 [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
 field is unset, then no logs are written.
        .google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;

      • mergeStackdriverLoggingConfig

        public Queue.Builder mergeStackdriverLoggingConfig​(StackdriverLoggingConfig value)
         Configuration options for writing logs to
 [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
 field is unset, then no logs are written.
        .google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;

      • clearStackdriverLoggingConfig

        public Queue.Builder clearStackdriverLoggingConfig()
         Configuration options for writing logs to
 [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
 field is unset, then no logs are written.
        .google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;

      • getStackdriverLoggingConfigBuilder

        public StackdriverLoggingConfig.Builder getStackdriverLoggingConfigBuilder()
         Configuration options for writing logs to
 [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
 field is unset, then no logs are written.
        .google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;

      • getStackdriverLoggingConfigOrBuilder

        public StackdriverLoggingConfigOrBuilder getStackdriverLoggingConfigOrBuilder()
         Configuration options for writing logs to
 [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
 field is unset, then no logs are written.
        .google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;
        Specified by:
        getStackdriverLoggingConfigOrBuilder in interface QueueOrBuilder

      • setUnknownFields

        public final Queue.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<Queue.Builder>

      • mergeUnknownFields

        public final Queue.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<Queue.Builder>