- 2.53.0 (latest)
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.12
- 2.2.0
- 2.1.11
public static final class Queue.Builder extends GeneratedMessageV3.Builder<Queue.Builder> implements QueueOrBuilderA 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Queue.BuilderImplements
QueueOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Queue.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
build()
public Queue build()| Returns | |
|---|---|
| Type | Description |
Queue |
|
buildPartial()
public Queue buildPartial()| Returns | |
|---|---|
| Type | Description |
Queue |
|
clear()
public Queue.Builder clear()| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
clearAppEngineRoutingOverride()
public Queue.Builder clearAppEngineRoutingOverride()Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected.
If set, app_engine_routing_override is used for all
App Engine tasks in the
queue, no matter what the setting is for the task-level
app_engine_routing.
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Queue.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
clearName()
public Queue.Builder clearName()Caller-specified and required in 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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_IDis the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.QUEUE_IDcan contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Queue.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
clearPurgeTime()
public Queue.Builder clearPurgeTime()Output only. The last time this queue was purged.
All tasks that were created before this time were purged.
A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console.
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;
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
clearRateLimits()
public Queue.Builder clearRateLimits()Rate limits for task dispatches.
rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:
- 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 controls what happens to particular a task after its first attempt fails. That is, 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, retry_config, and the queue's state.
- System throttling due to
429(Too Many Requests) or503(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
.google.cloud.tasks.v2.RateLimits rate_limits = 3;
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
clearRetryConfig()
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.
.google.cloud.tasks.v2.RetryConfig retry_config = 4;
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
clearStackdriverLoggingConfig()
public Queue.Builder clearStackdriverLoggingConfig()Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
.google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
clearState()
public Queue.Builder clearState()Output only. The state of the queue.
state can only be changed by calling
PauseQueue,
ResumeQueue, or uploading
queue.yaml/xml.
UpdateQueue cannot be used
to change state.
.google.cloud.tasks.v2.Queue.State state = 5;
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
This builder for chaining. |
clone()
public Queue.Builder clone()| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
getAppEngineRoutingOverride()
public AppEngineRouting getAppEngineRoutingOverride()Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected.
If set, app_engine_routing_override is used for all
App Engine tasks in the
queue, no matter what the setting is for the task-level
app_engine_routing.
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;
| Returns | |
|---|---|
| Type | Description |
AppEngineRouting |
The appEngineRoutingOverride. |
getAppEngineRoutingOverrideBuilder()
public AppEngineRouting.Builder getAppEngineRoutingOverrideBuilder()Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected.
If set, app_engine_routing_override is used for all
App Engine tasks in the
queue, no matter what the setting is for the task-level
app_engine_routing.
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;
| Returns | |
|---|---|
| Type | Description |
AppEngineRouting.Builder |
|
getAppEngineRoutingOverrideOrBuilder()
public AppEngineRoutingOrBuilder getAppEngineRoutingOverrideOrBuilder()Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected.
If set, app_engine_routing_override is used for all
App Engine tasks in the
queue, no matter what the setting is for the task-level
app_engine_routing.
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;
| Returns | |
|---|---|
| Type | Description |
AppEngineRoutingOrBuilder |
|
getDefaultInstanceForType()
public Queue getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Queue |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getName()
public String getName()Caller-specified and required in 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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_IDis the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.QUEUE_IDcan contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()Caller-specified and required in 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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_IDis the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.QUEUE_IDcan contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getPurgeTime()
public Timestamp getPurgeTime()Output only. The last time this queue was purged.
All tasks that were created before this time were purged.
A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console.
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;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The purgeTime. |
getPurgeTimeBuilder()
public Timestamp.Builder getPurgeTimeBuilder()Output only. The last time this queue was purged.
All tasks that were created before this time were purged.
A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console.
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;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getPurgeTimeOrBuilder()
public TimestampOrBuilder getPurgeTimeOrBuilder()Output only. The last time this queue was purged.
All tasks that were created before this time were purged.
A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console.
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;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getRateLimits()
public RateLimits getRateLimits()Rate limits for task dispatches.
rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:
- 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 controls what happens to particular a task after its first attempt fails. That is, 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, retry_config, and the queue's state.
- System throttling due to
429(Too Many Requests) or503(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
.google.cloud.tasks.v2.RateLimits rate_limits = 3;
| Returns | |
|---|---|
| Type | Description |
RateLimits |
The rateLimits. |
getRateLimitsBuilder()
public RateLimits.Builder getRateLimitsBuilder()Rate limits for task dispatches.
rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:
- 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 controls what happens to particular a task after its first attempt fails. That is, 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, retry_config, and the queue's state.
- System throttling due to
429(Too Many Requests) or503(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
.google.cloud.tasks.v2.RateLimits rate_limits = 3;
| Returns | |
|---|---|
| Type | Description |
RateLimits.Builder |
|
getRateLimitsOrBuilder()
public RateLimitsOrBuilder getRateLimitsOrBuilder()Rate limits for task dispatches.
rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:
- 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 controls what happens to particular a task after its first attempt fails. That is, 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, retry_config, and the queue's state.
- System throttling due to
429(Too Many Requests) or503(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
.google.cloud.tasks.v2.RateLimits rate_limits = 3;
| Returns | |
|---|---|
| Type | Description |
RateLimitsOrBuilder |
|
getRetryConfig()
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.
.google.cloud.tasks.v2.RetryConfig retry_config = 4;
| Returns | |
|---|---|
| Type | Description |
RetryConfig |
The retryConfig. |
getRetryConfigBuilder()
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.
.google.cloud.tasks.v2.RetryConfig retry_config = 4;
| Returns | |
|---|---|
| Type | Description |
RetryConfig.Builder |
|
getRetryConfigOrBuilder()
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.
.google.cloud.tasks.v2.RetryConfig retry_config = 4;
| Returns | |
|---|---|
| Type | Description |
RetryConfigOrBuilder |
|
getStackdriverLoggingConfig()
public StackdriverLoggingConfig getStackdriverLoggingConfig()Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
.google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;
| Returns | |
|---|---|
| Type | Description |
StackdriverLoggingConfig |
The stackdriverLoggingConfig. |
getStackdriverLoggingConfigBuilder()
public StackdriverLoggingConfig.Builder getStackdriverLoggingConfigBuilder()Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
.google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;
| Returns | |
|---|---|
| Type | Description |
StackdriverLoggingConfig.Builder |
|
getStackdriverLoggingConfigOrBuilder()
public StackdriverLoggingConfigOrBuilder getStackdriverLoggingConfigOrBuilder()Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
.google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;
| Returns | |
|---|---|
| Type | Description |
StackdriverLoggingConfigOrBuilder |
|
getState()
public Queue.State getState()Output only. The state of the queue.
state can only be changed by calling
PauseQueue,
ResumeQueue, or uploading
queue.yaml/xml.
UpdateQueue cannot be used
to change state.
.google.cloud.tasks.v2.Queue.State state = 5;
| Returns | |
|---|---|
| Type | Description |
Queue.State |
The state. |
getStateValue()
public int getStateValue()Output only. The state of the queue.
state can only be changed by calling
PauseQueue,
ResumeQueue, or uploading
queue.yaml/xml.
UpdateQueue cannot be used
to change state.
.google.cloud.tasks.v2.Queue.State state = 5;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
hasAppEngineRoutingOverride()
public boolean hasAppEngineRoutingOverride()Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected.
If set, app_engine_routing_override is used for all
App Engine tasks in the
queue, no matter what the setting is for the task-level
app_engine_routing.
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the appEngineRoutingOverride field is set. |
hasPurgeTime()
public boolean hasPurgeTime()Output only. The last time this queue was purged.
All tasks that were created before this time were purged.
A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console.
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the purgeTime field is set. |
hasRateLimits()
public boolean hasRateLimits()Rate limits for task dispatches.
rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:
- 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 controls what happens to particular a task after its first attempt fails. That is, 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, retry_config, and the queue's state.
- System throttling due to
429(Too Many Requests) or503(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
.google.cloud.tasks.v2.RateLimits rate_limits = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the rateLimits field is set. |
hasRetryConfig()
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.
.google.cloud.tasks.v2.RetryConfig retry_config = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the retryConfig field is set. |
hasStackdriverLoggingConfig()
public boolean hasStackdriverLoggingConfig()Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
.google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the stackdriverLoggingConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAppEngineRoutingOverride(AppEngineRouting value)
public Queue.Builder mergeAppEngineRoutingOverride(AppEngineRouting value)Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected.
If set, app_engine_routing_override is used for all
App Engine tasks in the
queue, no matter what the setting is for the task-level
app_engine_routing.
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
AppEngineRouting |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
mergeFrom(Queue other)
public Queue.Builder mergeFrom(Queue other)| Parameter | |
|---|---|
| Name | Description |
other |
Queue |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Queue.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Queue.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
mergePurgeTime(Timestamp value)
public Queue.Builder mergePurgeTime(Timestamp value)Output only. The last time this queue was purged.
All tasks that were created before this time were purged.
A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console.
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;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
mergeRateLimits(RateLimits value)
public Queue.Builder mergeRateLimits(RateLimits value)Rate limits for task dispatches.
rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:
- 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 controls what happens to particular a task after its first attempt fails. That is, 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, retry_config, and the queue's state.
- System throttling due to
429(Too Many Requests) or503(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
.google.cloud.tasks.v2.RateLimits rate_limits = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
RateLimits |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
mergeRetryConfig(RetryConfig value)
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.
.google.cloud.tasks.v2.RetryConfig retry_config = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
RetryConfig |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
mergeStackdriverLoggingConfig(StackdriverLoggingConfig value)
public Queue.Builder mergeStackdriverLoggingConfig(StackdriverLoggingConfig value)Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
.google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;
| Parameter | |
|---|---|
| Name | Description |
value |
StackdriverLoggingConfig |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Queue.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
setAppEngineRoutingOverride(AppEngineRouting value)
public Queue.Builder setAppEngineRoutingOverride(AppEngineRouting value)Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected.
If set, app_engine_routing_override is used for all
App Engine tasks in the
queue, no matter what the setting is for the task-level
app_engine_routing.
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
AppEngineRouting |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
setAppEngineRoutingOverride(AppEngineRouting.Builder builderForValue)
public Queue.Builder setAppEngineRoutingOverride(AppEngineRouting.Builder builderForValue)Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected.
If set, app_engine_routing_override is used for all
App Engine tasks in the
queue, no matter what the setting is for the task-level
app_engine_routing.
.google.cloud.tasks.v2.AppEngineRouting app_engine_routing_override = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AppEngineRouting.Builder |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Queue.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
setName(String value)
public Queue.Builder setName(String value)Caller-specified and required in 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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_IDis the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.QUEUE_IDcan contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Queue.Builder setNameBytes(ByteString value)Caller-specified and required in 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_IDcan contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_IDis the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.QUEUE_IDcan contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
This builder for chaining. |
setPurgeTime(Timestamp value)
public Queue.Builder setPurgeTime(Timestamp value)Output only. The last time this queue was purged.
All tasks that were created before this time were purged.
A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console.
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;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
setPurgeTime(Timestamp.Builder builderForValue)
public Queue.Builder setPurgeTime(Timestamp.Builder builderForValue)Output only. The last time this queue was purged.
All tasks that were created before this time were purged.
A queue can be purged using PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console.
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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
setRateLimits(RateLimits value)
public Queue.Builder setRateLimits(RateLimits value)Rate limits for task dispatches.
rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:
- 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 controls what happens to particular a task after its first attempt fails. That is, 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, retry_config, and the queue's state.
- System throttling due to
429(Too Many Requests) or503(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
.google.cloud.tasks.v2.RateLimits rate_limits = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
RateLimits |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
setRateLimits(RateLimits.Builder builderForValue)
public Queue.Builder setRateLimits(RateLimits.Builder builderForValue)Rate limits for task dispatches.
rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways:
- 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 controls what happens to particular a task after its first attempt fails. That is, 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, retry_config, and the queue's state.
- System throttling due to
429(Too Many Requests) or503(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
.google.cloud.tasks.v2.RateLimits rate_limits = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
RateLimits.Builder |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Queue.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
setRetryConfig(RetryConfig value)
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.
.google.cloud.tasks.v2.RetryConfig retry_config = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
RetryConfig |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
setRetryConfig(RetryConfig.Builder builderForValue)
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.
.google.cloud.tasks.v2.RetryConfig retry_config = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
RetryConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
setStackdriverLoggingConfig(StackdriverLoggingConfig value)
public Queue.Builder setStackdriverLoggingConfig(StackdriverLoggingConfig value)Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
.google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;
| Parameter | |
|---|---|
| Name | Description |
value |
StackdriverLoggingConfig |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
setStackdriverLoggingConfig(StackdriverLoggingConfig.Builder builderForValue)
public Queue.Builder setStackdriverLoggingConfig(StackdriverLoggingConfig.Builder builderForValue)Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
.google.cloud.tasks.v2.StackdriverLoggingConfig stackdriver_logging_config = 9;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
StackdriverLoggingConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|
setState(Queue.State value)
public Queue.Builder setState(Queue.State value)Output only. The state of the queue.
state can only be changed by calling
PauseQueue,
ResumeQueue, or uploading
queue.yaml/xml.
UpdateQueue cannot be used
to change state.
.google.cloud.tasks.v2.Queue.State state = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
Queue.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
This builder for chaining. |
setStateValue(int value)
public Queue.Builder setStateValue(int value)Output only. The state of the queue.
state can only be changed by calling
PauseQueue,
ResumeQueue, or uploading
queue.yaml/xml.
UpdateQueue cannot be used
to change state.
.google.cloud.tasks.v2.Queue.State state = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Queue.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder |
|