public static final class Queue.Builder extends 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
Modifier and Type | Method and Description |
---|---|
Queue.Builder |
addRepeatedField(Descriptors.FieldDescriptor field,
Object value) |
Queue |
build() |
Queue |
buildPartial() |
Queue.Builder |
clear() |
Queue.Builder |
clearAppEngineRoutingOverride()
Overrides for
[task-level app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
|
Queue.Builder |
clearField(Descriptors.FieldDescriptor field) |
Queue.Builder |
clearName()
Caller-specified and required in [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue],
after which it becomes output only.
|
Queue.Builder |
clearOneof(Descriptors.OneofDescriptor oneof) |
Queue.Builder |
clearPurgeTime()
Output only.
|
Queue.Builder |
clearRateLimits()
Rate limits for task dispatches.
|
Queue.Builder |
clearRetryConfig()
Settings that determine the retry behavior.
|
Queue.Builder |
clearStackdriverLoggingConfig()
Configuration options for writing logs to
[Stackdriver Logging](https://cloud.google.com/logging/docs/).
|
Queue.Builder |
clearState()
Output only.
|
Queue.Builder |
clone() |
AppEngineRouting |
getAppEngineRoutingOverride()
Overrides for
[task-level app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
|
AppEngineRouting.Builder |
getAppEngineRoutingOverrideBuilder()
Overrides for
[task-level app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
|
AppEngineRoutingOrBuilder |
getAppEngineRoutingOverrideOrBuilder()
Overrides for
[task-level app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
|
Queue |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
Descriptors.Descriptor |
getDescriptorForType() |
String |
getName()
Caller-specified and required in [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue],
after which it becomes output only.
|
ByteString |
getNameBytes()
Caller-specified and required in [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue],
after which it becomes output only.
|
Timestamp |
getPurgeTime()
Output only.
|
Timestamp.Builder |
getPurgeTimeBuilder()
Output only.
|
TimestampOrBuilder |
getPurgeTimeOrBuilder()
Output only.
|
RateLimits |
getRateLimits()
Rate limits for task dispatches.
|
RateLimits.Builder |
getRateLimitsBuilder()
Rate limits for task dispatches.
|
RateLimitsOrBuilder |
getRateLimitsOrBuilder()
Rate limits for task dispatches.
|
RetryConfig |
getRetryConfig()
Settings that determine the retry behavior.
|
RetryConfig.Builder |
getRetryConfigBuilder()
Settings that determine the retry behavior.
|
RetryConfigOrBuilder |
getRetryConfigOrBuilder()
Settings that determine the retry behavior.
|
StackdriverLoggingConfig |
getStackdriverLoggingConfig()
Configuration options for writing logs to
[Stackdriver Logging](https://cloud.google.com/logging/docs/).
|
StackdriverLoggingConfig.Builder |
getStackdriverLoggingConfigBuilder()
Configuration options for writing logs to
[Stackdriver Logging](https://cloud.google.com/logging/docs/).
|
StackdriverLoggingConfigOrBuilder |
getStackdriverLoggingConfigOrBuilder()
Configuration options for writing logs to
[Stackdriver Logging](https://cloud.google.com/logging/docs/).
|
Queue.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
boolean |
hasAppEngineRoutingOverride()
Overrides for
[task-level app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
|
boolean |
hasPurgeTime()
Output only.
|
boolean |
hasRateLimits()
Rate limits for task dispatches.
|
boolean |
hasRetryConfig()
Settings that determine the retry behavior.
|
boolean |
hasStackdriverLoggingConfig()
Configuration options for writing logs to
[Stackdriver Logging](https://cloud.google.com/logging/docs/).
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Queue.Builder |
mergeAppEngineRoutingOverride(AppEngineRouting value)
Overrides for
[task-level app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
|
Queue.Builder |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
Queue.Builder |
mergeFrom(Message other) |
Queue.Builder |
mergeFrom(Queue other) |
Queue.Builder |
mergePurgeTime(Timestamp value)
Output only.
|
Queue.Builder |
mergeRateLimits(RateLimits value)
Rate limits for task dispatches.
|
Queue.Builder |
mergeRetryConfig(RetryConfig value)
Settings that determine the retry behavior.
|
Queue.Builder |
mergeStackdriverLoggingConfig(StackdriverLoggingConfig value)
Configuration options for writing logs to
[Stackdriver Logging](https://cloud.google.com/logging/docs/).
|
Queue.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields) |
Queue.Builder |
setAppEngineRoutingOverride(AppEngineRouting.Builder builderForValue)
Overrides for
[task-level app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
|
Queue.Builder |
setAppEngineRoutingOverride(AppEngineRouting value)
Overrides for
[task-level app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
|
Queue.Builder |
setField(Descriptors.FieldDescriptor field,
Object value) |
Queue.Builder |
setName(String value)
Caller-specified and required in [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue],
after which it becomes output only.
|
Queue.Builder |
setNameBytes(ByteString value)
Caller-specified and required in [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue],
after which it becomes output only.
|
Queue.Builder |
setPurgeTime(Timestamp.Builder builderForValue)
Output only.
|
Queue.Builder |
setPurgeTime(Timestamp value)
Output only.
|
Queue.Builder |
setRateLimits(RateLimits.Builder builderForValue)
Rate limits for task dispatches.
|
Queue.Builder |
setRateLimits(RateLimits value)
Rate limits for task dispatches.
|
Queue.Builder |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
Object value) |
Queue.Builder |
setRetryConfig(RetryConfig.Builder builderForValue)
Settings that determine the retry behavior.
|
Queue.Builder |
setRetryConfig(RetryConfig value)
Settings that determine the retry behavior.
|
Queue.Builder |
setStackdriverLoggingConfig(StackdriverLoggingConfig.Builder builderForValue)
Configuration options for writing logs to
[Stackdriver Logging](https://cloud.google.com/logging/docs/).
|
Queue.Builder |
setStackdriverLoggingConfig(StackdriverLoggingConfig value)
Configuration options for writing logs to
[Stackdriver Logging](https://cloud.google.com/logging/docs/).
|
Queue.Builder |
setState(Queue.State value)
Output only.
|
Queue.Builder |
setStateValue(int value)
Output only.
|
Queue.Builder |
setUnknownFields(UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
mergeDelimitedFrom, mergeDelimitedFrom
mergeFrom
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3.Builder<Queue.Builder>
public Queue.Builder clear()
clear
in interface Message.Builder
clear
in interface MessageLite.Builder
clear
in class GeneratedMessageV3.Builder<Queue.Builder>
public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType
in interface Message.Builder
getDescriptorForType
in interface MessageOrBuilder
getDescriptorForType
in class GeneratedMessageV3.Builder<Queue.Builder>
public Queue getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
public Queue build()
build
in interface Message.Builder
build
in interface MessageLite.Builder
public Queue buildPartial()
buildPartial
in interface Message.Builder
buildPartial
in interface MessageLite.Builder
public Queue.Builder clone()
clone
in interface Message.Builder
clone
in interface MessageLite.Builder
clone
in class GeneratedMessageV3.Builder<Queue.Builder>
public Queue.Builder setField(Descriptors.FieldDescriptor field, Object value)
setField
in interface Message.Builder
setField
in class GeneratedMessageV3.Builder<Queue.Builder>
public Queue.Builder clearField(Descriptors.FieldDescriptor field)
clearField
in interface Message.Builder
clearField
in class GeneratedMessageV3.Builder<Queue.Builder>
public Queue.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof
in interface Message.Builder
clearOneof
in class GeneratedMessageV3.Builder<Queue.Builder>
public Queue.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField
in interface Message.Builder
setRepeatedField
in class GeneratedMessageV3.Builder<Queue.Builder>
public Queue.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
addRepeatedField
in interface Message.Builder
addRepeatedField
in class GeneratedMessageV3.Builder<Queue.Builder>
public Queue.Builder mergeFrom(Message other)
mergeFrom
in interface Message.Builder
mergeFrom
in class AbstractMessage.Builder<Queue.Builder>
public Queue.Builder mergeFrom(Queue other)
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3.Builder<Queue.Builder>
public Queue.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom
in interface Message.Builder
mergeFrom
in interface MessageLite.Builder
mergeFrom
in class AbstractMessage.Builder<Queue.Builder>
IOException
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;
getName
in interface QueueOrBuilder
public 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;
getNameBytes
in interface QueueOrBuilder
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;
value
- The name to set.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;
public Queue.Builder setNameBytes(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;
value
- The bytes for name to set.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;
hasAppEngineRoutingOverride
in interface QueueOrBuilder
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;
getAppEngineRoutingOverride
in interface QueueOrBuilder
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;
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;
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;
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;
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;
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;
getAppEngineRoutingOverrideOrBuilder
in interface QueueOrBuilder
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;
hasRateLimits
in interface QueueOrBuilder
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;
getRateLimits
in interface QueueOrBuilder
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;
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;
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;
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;
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;
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;
getRateLimitsOrBuilder
in interface QueueOrBuilder
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;
hasRetryConfig
in interface QueueOrBuilder
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;
getRetryConfig
in interface QueueOrBuilder
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;
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;
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;
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;
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;
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;
getRetryConfigOrBuilder
in interface QueueOrBuilder
public int getStateValue()
Output only. The state of the queue. `state` can only be changed by called [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;
getStateValue
in interface QueueOrBuilder
public Queue.Builder setStateValue(int value)
Output only. The state of the queue. `state` can only be changed by called [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;
value
- The enum numeric value on the wire for state to set.public Queue.State getState()
Output only. The state of the queue. `state` can only be changed by called [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;
getState
in interface QueueOrBuilder
public Queue.Builder setState(Queue.State value)
Output only. The state of the queue. `state` can only be changed by called [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;
value
- The state to set.public Queue.Builder clearState()
Output only. The state of the queue. `state` can only be changed by called [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;
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;
hasPurgeTime
in interface QueueOrBuilder
public 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;
getPurgeTime
in interface QueueOrBuilder
public Queue.Builder setPurgeTime(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;
public Queue.Builder setPurgeTime(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;
public Queue.Builder mergePurgeTime(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;
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;
public 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;
public 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;
getPurgeTimeOrBuilder
in interface QueueOrBuilder
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;
hasStackdriverLoggingConfig
in interface QueueOrBuilder
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;
getStackdriverLoggingConfig
in interface QueueOrBuilder
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;
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;
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;
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;
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;
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;
getStackdriverLoggingConfigOrBuilder
in interface QueueOrBuilder
public final Queue.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields
in interface Message.Builder
setUnknownFields
in class GeneratedMessageV3.Builder<Queue.Builder>
public final Queue.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields
in interface Message.Builder
mergeUnknownFields
in class GeneratedMessageV3.Builder<Queue.Builder>
Copyright © 2022 Google LLC. All rights reserved.