public final class RateLimits extends GeneratedMessageV3 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.<ListT>makeMutableCopy(ListT)
Static Fields
MAX_BURST_SIZE_FIELD_NUMBER
public static final int MAX_BURST_SIZE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MAX_CONCURRENT_DISPATCHES_FIELD_NUMBER
public static final int MAX_CONCURRENT_DISPATCHES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MAX_DISPATCHES_PER_SECOND_FIELD_NUMBER
public static final int MAX_DISPATCHES_PER_SECOND_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static RateLimits getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RateLimits.Builder newBuilder()
newBuilder(RateLimits prototype)
public static RateLimits.Builder newBuilder(RateLimits prototype)
public static RateLimits parseDelimitedFrom(InputStream input)
public static RateLimits parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RateLimits parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RateLimits parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RateLimits parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RateLimits parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RateLimits parseFrom(CodedInputStream input)
public static RateLimits parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RateLimits parseFrom(InputStream input)
public static RateLimits parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RateLimits parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RateLimits parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RateLimits> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public RateLimits getDefaultInstanceForType()
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.
- The maximum allowed value is 500.
This field has the same meaning as
rate in
queue.yaml/xml.
double max_dispatches_per_second = 1;
| Returns |
|---|
| Type | Description |
double | The maxDispatchesPerSecond.
|
getParserForType()
public Parser<RateLimits> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RateLimits.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RateLimits.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public RateLimits.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
