Package com.google.cloud.tasks.v2beta2

Class RateLimits.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<RateLimits.Builder>
com.google.cloud.tasks.v2beta2.RateLimits.Builder
All Implemented Interfaces:
RateLimitsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RateLimits
public static final class RateLimits.Builder extends com.google.protobuf.GeneratedMessage.Builder<RateLimits.Builder> implements RateLimitsOrBuilder
 Rate limits.

 This message determines the maximum rate that tasks can be dispatched by a
 queue, regardless of whether the dispatch is a first task attempt or a retry.

 Note: The debugging command,
 [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask], will run a task
 even if the queue has reached its
 [RateLimits][google.cloud.tasks.v2beta2.RateLimits].
Protobuf type google.cloud.tasks.v2beta2.RateLimits

  • Method Summary

    Modifier and Type
    Method
    Description
    RateLimits
    build()
     
    RateLimits
    buildPartial()
     
    RateLimits.Builder
    clear()
     
    RateLimits.Builder
    clearMaxBurstSize()
    The max burst size.
    RateLimits.Builder
    clearMaxConcurrentTasks()
    The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue.
    RateLimits.Builder
    clearMaxTasksDispatchedPerSecond()
    The maximum rate at which tasks are dispatched from this queue.
    RateLimits
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    int
    getMaxBurstSize()
    The max burst size.
    int
    getMaxConcurrentTasks()
    The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue.
    double
    getMaxTasksDispatchedPerSecond()
    The maximum rate at which tasks are dispatched from this queue.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    RateLimits.Builder
    mergeFrom(RateLimits other)
     
    RateLimits.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    RateLimits.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    RateLimits.Builder
    setMaxBurstSize(int value)
    The max burst size.
    RateLimits.Builder
    setMaxConcurrentTasks(int value)
    The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue.
    RateLimits.Builder
    setMaxTasksDispatchedPerSecond(double value)
    The maximum rate at which tasks are dispatched from this queue.

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

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

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

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • clear

      public RateLimits.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.GeneratedMessage.Builder<RateLimits.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.GeneratedMessage.Builder<RateLimits.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public RateLimits.Builder mergeFrom(RateLimits other)

    • isInitialized

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

    • mergeFrom

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

    • getMaxTasksDispatchedPerSecond

      public double getMaxTasksDispatchedPerSecond()
       The maximum rate at which tasks are dispatched from this queue.

 If unspecified when the queue is created, Cloud Tasks will pick the
 default.

 * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget],
 the maximum allowed value
 is 500.
 * This field is output only   for [pull
 queues][google.cloud.tasks.v2beta2.PullTarget]. In addition to the
 `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] requests
 are allowed per pull queue.


 This field has the same meaning as
 [rate in
 queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
      double max_tasks_dispatched_per_second = 1;
      Specified by:
      getMaxTasksDispatchedPerSecond in interface RateLimitsOrBuilder
      Returns:
      The maxTasksDispatchedPerSecond.

    • setMaxTasksDispatchedPerSecond

      public RateLimits.Builder setMaxTasksDispatchedPerSecond(double value)
       The maximum rate at which tasks are dispatched from this queue.

 If unspecified when the queue is created, Cloud Tasks will pick the
 default.

 * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget],
 the maximum allowed value
 is 500.
 * This field is output only   for [pull
 queues][google.cloud.tasks.v2beta2.PullTarget]. In addition to the
 `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] requests
 are allowed per pull queue.


 This field has the same meaning as
 [rate in
 queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
      double max_tasks_dispatched_per_second = 1;
      Parameters:
      value - The maxTasksDispatchedPerSecond to set.
      Returns:
      This builder for chaining.

    • clearMaxTasksDispatchedPerSecond

      public RateLimits.Builder clearMaxTasksDispatchedPerSecond()
       The maximum rate at which tasks are dispatched from this queue.

 If unspecified when the queue is created, Cloud Tasks will pick the
 default.

 * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget],
 the maximum allowed value
 is 500.
 * This field is output only   for [pull
 queues][google.cloud.tasks.v2beta2.PullTarget]. In addition to the
 `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
 [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] requests
 are allowed per pull queue.


 This field has the same meaning as
 [rate in
 queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
      double max_tasks_dispatched_per_second = 1;
      Returns:
      This builder for chaining.

    • getMaxBurstSize

      public int getMaxBurstSize()
       The max burst size.

 Max burst size limits how fast tasks in queue are processed when
 many tasks are in the queue and the rate is high. This field
 allows the queue to have a high rate so processing starts shortly
 after a task is enqueued, but still limits resource usage when
 many tasks are enqueued in a short period of time.

 The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
 algorithm is used to control the rate of task dispatches. Each
 queue has a token bucket that holds tokens, up to the maximum
 specified by `max_burst_size`. Each time a task is dispatched, a
 token is removed from the bucket. Tasks will be dispatched until
 the queue's bucket runs out of tokens. The bucket will be
 continuously refilled with new tokens based on
 [max_dispatches_per_second][RateLimits.max_dispatches_per_second].

 The default value of `max_burst_size` is picked by Cloud Tasks
 based on the value of
 [max_dispatches_per_second][RateLimits.max_dispatches_per_second].

 The maximum value of `max_burst_size` is 500.

 For App Engine queues that were created or updated using
 `queue.yaml/xml`, `max_burst_size` is equal to
 [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
 If
 [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] is called
 on a queue without explicitly setting a value for `max_burst_size`,
 `max_burst_size` value will get updated if
 [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] is
 updating [max_dispatches_per_second][RateLimits.max_dispatches_per_second].
      int32 max_burst_size = 2;
      Specified by:
      getMaxBurstSize in interface RateLimitsOrBuilder
      Returns:
      The maxBurstSize.

    • setMaxBurstSize

      public RateLimits.Builder setMaxBurstSize(int value)
       The max burst size.

 Max burst size limits how fast tasks in queue are processed when
 many tasks are in the queue and the rate is high. This field
 allows the queue to have a high rate so processing starts shortly
 after a task is enqueued, but still limits resource usage when
 many tasks are enqueued in a short period of time.

 The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
 algorithm is used to control the rate of task dispatches. Each
 queue has a token bucket that holds tokens, up to the maximum
 specified by `max_burst_size`. Each time a task is dispatched, a
 token is removed from the bucket. Tasks will be dispatched until
 the queue's bucket runs out of tokens. The bucket will be
 continuously refilled with new tokens based on
 [max_dispatches_per_second][RateLimits.max_dispatches_per_second].

 The default value of `max_burst_size` is picked by Cloud Tasks
 based on the value of
 [max_dispatches_per_second][RateLimits.max_dispatches_per_second].

 The maximum value of `max_burst_size` is 500.

 For App Engine queues that were created or updated using
 `queue.yaml/xml`, `max_burst_size` is equal to
 [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
 If
 [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] is called
 on a queue without explicitly setting a value for `max_burst_size`,
 `max_burst_size` value will get updated if
 [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] is
 updating [max_dispatches_per_second][RateLimits.max_dispatches_per_second].
      int32 max_burst_size = 2;
      Parameters:
      value - The maxBurstSize to set.
      Returns:
      This builder for chaining.

    • clearMaxBurstSize

      public RateLimits.Builder clearMaxBurstSize()
       The max burst size.

 Max burst size limits how fast tasks in queue are processed when
 many tasks are in the queue and the rate is high. This field
 allows the queue to have a high rate so processing starts shortly
 after a task is enqueued, but still limits resource usage when
 many tasks are enqueued in a short period of time.

 The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
 algorithm is used to control the rate of task dispatches. Each
 queue has a token bucket that holds tokens, up to the maximum
 specified by `max_burst_size`. Each time a task is dispatched, a
 token is removed from the bucket. Tasks will be dispatched until
 the queue's bucket runs out of tokens. The bucket will be
 continuously refilled with new tokens based on
 [max_dispatches_per_second][RateLimits.max_dispatches_per_second].

 The default value of `max_burst_size` is picked by Cloud Tasks
 based on the value of
 [max_dispatches_per_second][RateLimits.max_dispatches_per_second].

 The maximum value of `max_burst_size` is 500.

 For App Engine queues that were created or updated using
 `queue.yaml/xml`, `max_burst_size` is equal to
 [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
 If
 [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] is called
 on a queue without explicitly setting a value for `max_burst_size`,
 `max_burst_size` value will get updated if
 [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] is
 updating [max_dispatches_per_second][RateLimits.max_dispatches_per_second].
      int32 max_burst_size = 2;
      Returns:
      This builder for chaining.

    • getMaxConcurrentTasks

      public int getMaxConcurrentTasks()
       The maximum number of concurrent tasks that Cloud Tasks allows
 to be dispatched for this queue. After this threshold has been
 reached, Cloud Tasks stops dispatching tasks until the number of
 concurrent requests decreases.

 If unspecified when the queue is created, Cloud Tasks will pick the
 default.


 The maximum allowed value is 5,000.

 This field is output only for
 [pull queues][google.cloud.tasks.v2beta2.PullTarget] and always -1, which
 indicates no limit. No other queue types can have `max_concurrent_tasks`
 set to -1.


 This field has the same meaning as
 [max_concurrent_requests in
 queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
      int32 max_concurrent_tasks = 3;
      Specified by:
      getMaxConcurrentTasks in interface RateLimitsOrBuilder
      Returns:
      The maxConcurrentTasks.

    • setMaxConcurrentTasks

      public RateLimits.Builder setMaxConcurrentTasks(int value)
       The maximum number of concurrent tasks that Cloud Tasks allows
 to be dispatched for this queue. After this threshold has been
 reached, Cloud Tasks stops dispatching tasks until the number of
 concurrent requests decreases.

 If unspecified when the queue is created, Cloud Tasks will pick the
 default.


 The maximum allowed value is 5,000.

 This field is output only for
 [pull queues][google.cloud.tasks.v2beta2.PullTarget] and always -1, which
 indicates no limit. No other queue types can have `max_concurrent_tasks`
 set to -1.


 This field has the same meaning as
 [max_concurrent_requests in
 queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
      int32 max_concurrent_tasks = 3;
      Parameters:
      value - The maxConcurrentTasks to set.
      Returns:
      This builder for chaining.

    • clearMaxConcurrentTasks

      public RateLimits.Builder clearMaxConcurrentTasks()
       The maximum number of concurrent tasks that Cloud Tasks allows
 to be dispatched for this queue. After this threshold has been
 reached, Cloud Tasks stops dispatching tasks until the number of
 concurrent requests decreases.

 If unspecified when the queue is created, Cloud Tasks will pick the
 default.


 The maximum allowed value is 5,000.

 This field is output only for
 [pull queues][google.cloud.tasks.v2beta2.PullTarget] and always -1, which
 indicates no limit. No other queue types can have `max_concurrent_tasks`
 set to -1.


 This field has the same meaning as
 [max_concurrent_requests in
 queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
      int32 max_concurrent_tasks = 3;
      Returns:
      This builder for chaining.