Package com.google.cloud.tasks.v2

Interface RateLimitsOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RateLimits, RateLimits.Builder
    public interface RateLimitsOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getMaxBurstSize()
      Output only.
      int getMaxConcurrentDispatches()
      The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue.
      double getMaxDispatchesPerSecond()
      The maximum rate at which tasks are dispatched from this queue.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getMaxDispatchesPerSecond

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

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

 * The maximum allowed value is 500.


 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_dispatches_per_second = 1;
        Returns:
        The maxDispatchesPerSecond.

      • getMaxBurstSize

        int getMaxBurstSize()
         Output only. 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][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second].

 Cloud Tasks will pick the value of `max_burst_size` based on the
 value of
 [max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second].

 For 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).
 Since `max_burst_size` is output only, if
 [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] is called on a
 queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on
 the value of
 [max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second],
 regardless of whether
 [max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second]
 is updated.
        int32 max_burst_size = 2;
        Returns:
        The maxBurstSize.

      • getMaxConcurrentDispatches

        int getMaxConcurrentDispatches()
         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 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_dispatches = 3;
        Returns:
        The maxConcurrentDispatches.