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, target types, and others.
Protobuf type google.cloud.tasks.v2beta2.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 | |
clearAppEngineHttpTarget()
public Queue.Builder clearAppEngineHttpTarget()App Engine HTTP target.
An App Engine queue is a queue that has an AppEngineHttpTarget.
.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;
| 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 | |
clearHttpTarget()
public Queue.Builder clearHttpTarget()An http_target is used to override the target values for HTTP tasks.
.google.cloud.tasks.v2beta2.HttpTarget http_target = 17;
| 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 | |
clearPullTarget()
public Queue.Builder clearPullTarget()Pull target.
A pull queue is a queue that has a PullTarget.
.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;
| 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 = 8;
| 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 how tasks are attempted 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).
.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;
| 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.v2beta2.RetryConfig retry_config = 6;
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
clearState()
public Queue.Builder clearState()Output only. The state of the queue.
state can only be changed by called
PauseQueue,
ResumeQueue, or
uploading
queue.yaml/xml.
UpdateQueue cannot be
used to change state.
.google.cloud.tasks.v2beta2.Queue.State state = 7;
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | This builder for chaining. |
clearStats()
public Queue.Builder clearStats()Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.
.google.cloud.tasks.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
clearTargetType()
public Queue.Builder clearTargetType()| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
clearTaskTtl()
public Queue.Builder clearTaskTtl()The maximum amount of time that a task will be retained in this queue.
Queues created by Cloud Tasks have a default task_ttl of 31 days.
After a task has lived for task_ttl, the task will be deleted
regardless of whether it was dispatched or not.
The task_ttl for queues created via queue.yaml/xml is equal to the
maximum duration because there is a
storage quota for
these queues. To view the maximum valid duration, see the documentation for
Duration.
.google.protobuf.Duration task_ttl = 9;
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
clearTombstoneTtl()
public Queue.Builder clearTombstoneTtl()The task tombstone time to live (TTL).
After a task is deleted or completed, the task's tombstone is
retained for the length of time specified by tombstone_ttl.
The tombstone is used by task de-duplication; another task with the same
name can't be created until the tombstone has expired. For more information
about task de-duplication, see the documentation for
CreateTaskRequest.
Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.
.google.protobuf.Duration tombstone_ttl = 10;
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
clone()
public Queue.Builder clone()| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
getAppEngineHttpTarget()
public AppEngineHttpTarget getAppEngineHttpTarget()App Engine HTTP target.
An App Engine queue is a queue that has an AppEngineHttpTarget.
.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;
| Returns | |
|---|---|
| Type | Description |
AppEngineHttpTarget | The appEngineHttpTarget. |
getAppEngineHttpTargetBuilder()
public AppEngineHttpTarget.Builder getAppEngineHttpTargetBuilder()App Engine HTTP target.
An App Engine queue is a queue that has an AppEngineHttpTarget.
.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;
| Returns | |
|---|---|
| Type | Description |
AppEngineHttpTarget.Builder | |
getAppEngineHttpTargetOrBuilder()
public AppEngineHttpTargetOrBuilder getAppEngineHttpTargetOrBuilder()App Engine HTTP target.
An App Engine queue is a queue that has an AppEngineHttpTarget.
.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;
| Returns | |
|---|---|
| Type | Description |
AppEngineHttpTargetOrBuilder | |
getDefaultInstanceForType()
public Queue getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Queue | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getHttpTarget()
public HttpTarget getHttpTarget()An http_target is used to override the target values for HTTP tasks.
.google.cloud.tasks.v2beta2.HttpTarget http_target = 17;
| Returns | |
|---|---|
| Type | Description |
HttpTarget | The httpTarget. |
getHttpTargetBuilder()
public HttpTarget.Builder getHttpTargetBuilder()An http_target is used to override the target values for HTTP tasks.
.google.cloud.tasks.v2beta2.HttpTarget http_target = 17;
| Returns | |
|---|---|
| Type | Description |
HttpTarget.Builder | |
getHttpTargetOrBuilder()
public HttpTargetOrBuilder getHttpTargetOrBuilder()An http_target is used to override the target values for HTTP tasks.
.google.cloud.tasks.v2beta2.HttpTarget http_target = 17;
| Returns | |
|---|---|
| Type | Description |
HttpTargetOrBuilder | |
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. |
getPullTarget()
public PullTarget getPullTarget()Pull target.
A pull queue is a queue that has a PullTarget.
.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;
| Returns | |
|---|---|
| Type | Description |
PullTarget | The pullTarget. |
getPullTargetBuilder()
public PullTarget.Builder getPullTargetBuilder()Pull target.
A pull queue is a queue that has a PullTarget.
.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;
| Returns | |
|---|---|
| Type | Description |
PullTarget.Builder | |
getPullTargetOrBuilder()
public PullTargetOrBuilder getPullTargetOrBuilder()Pull target.
A pull queue is a queue that has a PullTarget.
.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;
| Returns | |
|---|---|
| Type | Description |
PullTargetOrBuilder | |
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 = 8;
| 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 = 8;
| 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 = 8;
| 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 how tasks are attempted 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).
.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;
| 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 how tasks are attempted 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).
.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;
| 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 how tasks are attempted 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).
.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;
| 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.v2beta2.RetryConfig retry_config = 6;
| 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.v2beta2.RetryConfig retry_config = 6;
| 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.v2beta2.RetryConfig retry_config = 6;
| Returns | |
|---|---|
| Type | Description |
RetryConfigOrBuilder | |
getState()
public Queue.State getState()Output only. The state of the queue.
state can only be changed by called
PauseQueue,
ResumeQueue, or
uploading
queue.yaml/xml.
UpdateQueue cannot be
used to change state.
.google.cloud.tasks.v2beta2.Queue.State state = 7;
| Returns | |
|---|---|
| Type | Description |
Queue.State | The state. |
getStateValue()
public int getStateValue()Output only. The state of the queue.
state can only be changed by called
PauseQueue,
ResumeQueue, or
uploading
queue.yaml/xml.
UpdateQueue cannot be
used to change state.
.google.cloud.tasks.v2beta2.Queue.State state = 7;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for state. |
getStats()
public QueueStats getStats()Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.
.google.cloud.tasks.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
QueueStats | The stats. |
getStatsBuilder()
public QueueStats.Builder getStatsBuilder()Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.
.google.cloud.tasks.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
QueueStats.Builder | |
getStatsOrBuilder()
public QueueStatsOrBuilder getStatsOrBuilder()Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.
.google.cloud.tasks.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
QueueStatsOrBuilder | |
getTargetTypeCase()
public Queue.TargetTypeCase getTargetTypeCase()| Returns | |
|---|---|
| Type | Description |
Queue.TargetTypeCase | |
getTaskTtl()
public Duration getTaskTtl()The maximum amount of time that a task will be retained in this queue.
Queues created by Cloud Tasks have a default task_ttl of 31 days.
After a task has lived for task_ttl, the task will be deleted
regardless of whether it was dispatched or not.
The task_ttl for queues created via queue.yaml/xml is equal to the
maximum duration because there is a
storage quota for
these queues. To view the maximum valid duration, see the documentation for
Duration.
.google.protobuf.Duration task_ttl = 9;
| Returns | |
|---|---|
| Type | Description |
Duration | The taskTtl. |
getTaskTtlBuilder()
public Duration.Builder getTaskTtlBuilder()The maximum amount of time that a task will be retained in this queue.
Queues created by Cloud Tasks have a default task_ttl of 31 days.
After a task has lived for task_ttl, the task will be deleted
regardless of whether it was dispatched or not.
The task_ttl for queues created via queue.yaml/xml is equal to the
maximum duration because there is a
storage quota for
these queues. To view the maximum valid duration, see the documentation for
Duration.
.google.protobuf.Duration task_ttl = 9;
| Returns | |
|---|---|
| Type | Description |
Builder | |
getTaskTtlOrBuilder()
public DurationOrBuilder getTaskTtlOrBuilder()The maximum amount of time that a task will be retained in this queue.
Queues created by Cloud Tasks have a default task_ttl of 31 days.
After a task has lived for task_ttl, the task will be deleted
regardless of whether it was dispatched or not.
The task_ttl for queues created via queue.yaml/xml is equal to the
maximum duration because there is a
storage quota for
these queues. To view the maximum valid duration, see the documentation for
Duration.
.google.protobuf.Duration task_ttl = 9;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder | |
getTombstoneTtl()
public Duration getTombstoneTtl()The task tombstone time to live (TTL).
After a task is deleted or completed, the task's tombstone is
retained for the length of time specified by tombstone_ttl.
The tombstone is used by task de-duplication; another task with the same
name can't be created until the tombstone has expired. For more information
about task de-duplication, see the documentation for
CreateTaskRequest.
Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.
.google.protobuf.Duration tombstone_ttl = 10;
| Returns | |
|---|---|
| Type | Description |
Duration | The tombstoneTtl. |
getTombstoneTtlBuilder()
public Duration.Builder getTombstoneTtlBuilder()The task tombstone time to live (TTL).
After a task is deleted or completed, the task's tombstone is
retained for the length of time specified by tombstone_ttl.
The tombstone is used by task de-duplication; another task with the same
name can't be created until the tombstone has expired. For more information
about task de-duplication, see the documentation for
CreateTaskRequest.
Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.
.google.protobuf.Duration tombstone_ttl = 10;
| Returns | |
|---|---|
| Type | Description |
Builder | |
getTombstoneTtlOrBuilder()
public DurationOrBuilder getTombstoneTtlOrBuilder()The task tombstone time to live (TTL).
After a task is deleted or completed, the task's tombstone is
retained for the length of time specified by tombstone_ttl.
The tombstone is used by task de-duplication; another task with the same
name can't be created until the tombstone has expired. For more information
about task de-duplication, see the documentation for
CreateTaskRequest.
Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.
.google.protobuf.Duration tombstone_ttl = 10;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder | |
hasAppEngineHttpTarget()
public boolean hasAppEngineHttpTarget()App Engine HTTP target.
An App Engine queue is a queue that has an AppEngineHttpTarget.
.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the appEngineHttpTarget field is set. |
hasHttpTarget()
public boolean hasHttpTarget()An http_target is used to override the target values for HTTP tasks.
.google.cloud.tasks.v2beta2.HttpTarget http_target = 17;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the httpTarget field is set. |
hasPullTarget()
public boolean hasPullTarget()Pull target.
A pull queue is a queue that has a PullTarget.
.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the pullTarget 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 = 8;
| 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 how tasks are attempted 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).
.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;
| 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.v2beta2.RetryConfig retry_config = 6;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the retryConfig field is set. |
hasStats()
public boolean hasStats()Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.
.google.cloud.tasks.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the stats field is set. |
hasTaskTtl()
public boolean hasTaskTtl()The maximum amount of time that a task will be retained in this queue.
Queues created by Cloud Tasks have a default task_ttl of 31 days.
After a task has lived for task_ttl, the task will be deleted
regardless of whether it was dispatched or not.
The task_ttl for queues created via queue.yaml/xml is equal to the
maximum duration because there is a
storage quota for
these queues. To view the maximum valid duration, see the documentation for
Duration.
.google.protobuf.Duration task_ttl = 9;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the taskTtl field is set. |
hasTombstoneTtl()
public boolean hasTombstoneTtl()The task tombstone time to live (TTL).
After a task is deleted or completed, the task's tombstone is
retained for the length of time specified by tombstone_ttl.
The tombstone is used by task de-duplication; another task with the same
name can't be created until the tombstone has expired. For more information
about task de-duplication, see the documentation for
CreateTaskRequest.
Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.
.google.protobuf.Duration tombstone_ttl = 10;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the tombstoneTtl field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeAppEngineHttpTarget(AppEngineHttpTarget value)
public Queue.Builder mergeAppEngineHttpTarget(AppEngineHttpTarget value)App Engine HTTP target.
An App Engine queue is a queue that has an AppEngineHttpTarget.
.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;
| Parameter | |
|---|---|
| Name | Description |
value | AppEngineHttpTarget |
| 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 | |
mergeHttpTarget(HttpTarget value)
public Queue.Builder mergeHttpTarget(HttpTarget value)An http_target is used to override the target values for HTTP tasks.
.google.cloud.tasks.v2beta2.HttpTarget http_target = 17;
| Parameter | |
|---|---|
| Name | Description |
value | HttpTarget |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
mergePullTarget(PullTarget value)
public Queue.Builder mergePullTarget(PullTarget value)Pull target.
A pull queue is a queue that has a PullTarget.
.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;
| Parameter | |
|---|---|
| Name | Description |
value | PullTarget |
| 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 = 8;
| 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 how tasks are attempted 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).
.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;
| 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.v2beta2.RetryConfig retry_config = 6;
| Parameter | |
|---|---|
| Name | Description |
value | RetryConfig |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
mergeStats(QueueStats value)
public Queue.Builder mergeStats(QueueStats value)Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.
.google.cloud.tasks.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | QueueStats |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
mergeTaskTtl(Duration value)
public Queue.Builder mergeTaskTtl(Duration value)The maximum amount of time that a task will be retained in this queue.
Queues created by Cloud Tasks have a default task_ttl of 31 days.
After a task has lived for task_ttl, the task will be deleted
regardless of whether it was dispatched or not.
The task_ttl for queues created via queue.yaml/xml is equal to the
maximum duration because there is a
storage quota for
these queues. To view the maximum valid duration, see the documentation for
Duration.
.google.protobuf.Duration task_ttl = 9;
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
mergeTombstoneTtl(Duration value)
public Queue.Builder mergeTombstoneTtl(Duration value)The task tombstone time to live (TTL).
After a task is deleted or completed, the task's tombstone is
retained for the length of time specified by tombstone_ttl.
The tombstone is used by task de-duplication; another task with the same
name can't be created until the tombstone has expired. For more information
about task de-duplication, see the documentation for
CreateTaskRequest.
Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.
.google.protobuf.Duration tombstone_ttl = 10;
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| 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 | |
setAppEngineHttpTarget(AppEngineHttpTarget value)
public Queue.Builder setAppEngineHttpTarget(AppEngineHttpTarget value)App Engine HTTP target.
An App Engine queue is a queue that has an AppEngineHttpTarget.
.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;
| Parameter | |
|---|---|
| Name | Description |
value | AppEngineHttpTarget |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
setAppEngineHttpTarget(AppEngineHttpTarget.Builder builderForValue)
public Queue.Builder setAppEngineHttpTarget(AppEngineHttpTarget.Builder builderForValue)App Engine HTTP target.
An App Engine queue is a queue that has an AppEngineHttpTarget.
.google.cloud.tasks.v2beta2.AppEngineHttpTarget app_engine_http_target = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | AppEngineHttpTarget.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 | |
setHttpTarget(HttpTarget value)
public Queue.Builder setHttpTarget(HttpTarget value)An http_target is used to override the target values for HTTP tasks.
.google.cloud.tasks.v2beta2.HttpTarget http_target = 17;
| Parameter | |
|---|---|
| Name | Description |
value | HttpTarget |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
setHttpTarget(HttpTarget.Builder builderForValue)
public Queue.Builder setHttpTarget(HttpTarget.Builder builderForValue)An http_target is used to override the target values for HTTP tasks.
.google.cloud.tasks.v2beta2.HttpTarget http_target = 17;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | HttpTarget.Builder |
| 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. |
setPullTarget(PullTarget value)
public Queue.Builder setPullTarget(PullTarget value)Pull target.
A pull queue is a queue that has a PullTarget.
.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;
| Parameter | |
|---|---|
| Name | Description |
value | PullTarget |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
setPullTarget(PullTarget.Builder builderForValue)
public Queue.Builder setPullTarget(PullTarget.Builder builderForValue)Pull target.
A pull queue is a queue that has a PullTarget.
.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | PullTarget.Builder |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
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 = 8;
| 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 = 8;
| 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 how tasks are attempted 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).
.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;
| 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 how tasks are attempted 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).
.google.cloud.tasks.v2beta2.RateLimits rate_limits = 5;
| 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.v2beta2.RetryConfig retry_config = 6;
| 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.v2beta2.RetryConfig retry_config = 6;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | RetryConfig.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 called
PauseQueue,
ResumeQueue, or
uploading
queue.yaml/xml.
UpdateQueue cannot be
used to change state.
.google.cloud.tasks.v2beta2.Queue.State state = 7;
| 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 called
PauseQueue,
ResumeQueue, or
uploading
queue.yaml/xml.
UpdateQueue cannot be
used to change state.
.google.cloud.tasks.v2beta2.Queue.State state = 7;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | This builder for chaining. |
setStats(QueueStats value)
public Queue.Builder setStats(QueueStats value)Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.
.google.cloud.tasks.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | QueueStats |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
setStats(QueueStats.Builder builderForValue)
public Queue.Builder setStats(QueueStats.Builder builderForValue)Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.
.google.cloud.tasks.v2beta2.QueueStats stats = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | QueueStats.Builder |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
setTaskTtl(Duration value)
public Queue.Builder setTaskTtl(Duration value)The maximum amount of time that a task will be retained in this queue.
Queues created by Cloud Tasks have a default task_ttl of 31 days.
After a task has lived for task_ttl, the task will be deleted
regardless of whether it was dispatched or not.
The task_ttl for queues created via queue.yaml/xml is equal to the
maximum duration because there is a
storage quota for
these queues. To view the maximum valid duration, see the documentation for
Duration.
.google.protobuf.Duration task_ttl = 9;
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
setTaskTtl(Duration.Builder builderForValue)
public Queue.Builder setTaskTtl(Duration.Builder builderForValue)The maximum amount of time that a task will be retained in this queue.
Queues created by Cloud Tasks have a default task_ttl of 31 days.
After a task has lived for task_ttl, the task will be deleted
regardless of whether it was dispatched or not.
The task_ttl for queues created via queue.yaml/xml is equal to the
maximum duration because there is a
storage quota for
these queues. To view the maximum valid duration, see the documentation for
Duration.
.google.protobuf.Duration task_ttl = 9;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
setTombstoneTtl(Duration value)
public Queue.Builder setTombstoneTtl(Duration value)The task tombstone time to live (TTL).
After a task is deleted or completed, the task's tombstone is
retained for the length of time specified by tombstone_ttl.
The tombstone is used by task de-duplication; another task with the same
name can't be created until the tombstone has expired. For more information
about task de-duplication, see the documentation for
CreateTaskRequest.
Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.
.google.protobuf.Duration tombstone_ttl = 10;
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
setTombstoneTtl(Duration.Builder builderForValue)
public Queue.Builder setTombstoneTtl(Duration.Builder builderForValue)The task tombstone time to live (TTL).
After a task is deleted or completed, the task's tombstone is
retained for the length of time specified by tombstone_ttl.
The tombstone is used by task de-duplication; another task with the same
name can't be created until the tombstone has expired. For more information
about task de-duplication, see the documentation for
CreateTaskRequest.
Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.
.google.protobuf.Duration tombstone_ttl = 10;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final Queue.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Queue.Builder | |