public static final class RateLimits.Builder extends GeneratedMessageV3.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, will run a task even if
the queue has reached its RateLimits.
Protobuf type google.cloud.tasks.v2.RateLimits
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RateLimits.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public RateLimits build()
buildPartial()
public RateLimits buildPartial()
clear()
public RateLimits.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public RateLimits.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearMaxBurstSize()
public RateLimits.Builder clearMaxBurstSize()
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
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.
Cloud Tasks will pick the value of max_burst_size based on the
value of
max_dispatches_per_second.
For queues that were created or updated using
queue.yaml/xml, max_burst_size is equal to
bucket_size.
Since max_burst_size is output only, if
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,
regardless of whether
max_dispatches_per_second
is updated.
int32 max_burst_size = 2;
clearMaxConcurrentDispatches()
public RateLimits.Builder clearMaxConcurrentDispatches()
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.
int32 max_concurrent_dispatches = 3;
clearMaxDispatchesPerSecond()
public RateLimits.Builder clearMaxDispatchesPerSecond()
The maximum rate at which tasks are dispatched from this queue.
If unspecified when the queue is created, Cloud Tasks will pick the
default.
double max_dispatches_per_second = 1;
clearOneof(Descriptors.OneofDescriptor oneof)
public RateLimits.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clone()
public RateLimits.Builder clone()
Overrides
getDefaultInstanceForType()
public RateLimits getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getMaxBurstSize()
public 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
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.
Cloud Tasks will pick the value of max_burst_size based on the
value of
max_dispatches_per_second.
For queues that were created or updated using
queue.yaml/xml, max_burst_size is equal to
bucket_size.
Since max_burst_size is output only, if
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,
regardless of whether
max_dispatches_per_second
is updated.
int32 max_burst_size = 2;
| Returns |
|---|
| Type | Description |
int | The maxBurstSize.
|
getMaxConcurrentDispatches()
public 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.
int32 max_concurrent_dispatches = 3;
| Returns |
|---|
| Type | Description |
int | The maxConcurrentDispatches.
|
getMaxDispatchesPerSecond()
public 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.
double max_dispatches_per_second = 1;
| Returns |
|---|
| Type | Description |
double | The maxDispatchesPerSecond.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(RateLimits other)
public RateLimits.Builder mergeFrom(RateLimits other)
public RateLimits.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public RateLimits.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RateLimits.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public RateLimits.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setMaxBurstSize(int value)
public RateLimits.Builder setMaxBurstSize(int value)
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
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.
Cloud Tasks will pick the value of max_burst_size based on the
value of
max_dispatches_per_second.
For queues that were created or updated using
queue.yaml/xml, max_burst_size is equal to
bucket_size.
Since max_burst_size is output only, if
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,
regardless of whether
max_dispatches_per_second
is updated.
int32 max_burst_size = 2;
| Parameter |
|---|
| Name | Description |
value | int
The maxBurstSize to set.
|
setMaxConcurrentDispatches(int value)
public RateLimits.Builder setMaxConcurrentDispatches(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 has the same meaning as
max_concurrent_requests in
queue.yaml/xml.
int32 max_concurrent_dispatches = 3;
| Parameter |
|---|
| Name | Description |
value | int
The maxConcurrentDispatches to set.
|
setMaxDispatchesPerSecond(double value)
public RateLimits.Builder setMaxDispatchesPerSecond(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.
double max_dispatches_per_second = 1;
| Parameter |
|---|
| Name | Description |
value | double
The maxDispatchesPerSecond to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RateLimits.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final RateLimits.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
