Class Queue.Builder (2.4.0)

publicstaticfinalclass Queue.BuilderextendsGeneratedMessageV3.Builder<Queue.Builder>implementsQueueOrBuilder

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, target types, and others.

Protobuf type google.cloud.tasks.v2beta2.Queue

Implements

QueueOrBuilder

Inherited Members

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicQueue.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
value Object
Returns
Type Description
Overrides

build()

publicQueuebuild()
Returns
Type Description

buildPartial()

publicQueuebuildPartial()
Returns
Type Description

clear()

publicQueue.Builderclear()
Returns
Type Description
Overrides

clearAppEngineHttpTarget()

publicQueue.BuilderclearAppEngineHttpTarget()

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

clearField(Descriptors.FieldDescriptor field)

publicQueue.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
Returns
Type Description
Overrides

clearName()

publicQueue.BuilderclearName()

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_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
  • LOCATION_ID is 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_ID can 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)

publicQueue.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
Returns
Type Description
Overrides

clearPullTarget()

publicQueue.BuilderclearPullTarget()

Pull target. A pull queue is a queue that has a PullTarget.

.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;

Returns
Type Description

clearPurgeTime()

publicQueue.BuilderclearPurgeTime()

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

clearRateLimits()

publicQueue.BuilderclearRateLimits()

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

clearRetryConfig()

publicQueue.BuilderclearRetryConfig()

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

clearState()

publicQueue.BuilderclearState()

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.v2beta2.Queue.State state = 7;

Returns
Type Description
Queue.Builder

This builder for chaining.

clearStats()

publicQueue.BuilderclearStats()

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

clearTargetType()

publicQueue.BuilderclearTargetType()
Returns
Type Description

clearTaskTtl()

publicQueue.BuilderclearTaskTtl()

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

clearTombstoneTtl()

publicQueue.BuilderclearTombstoneTtl()

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

clone()

publicQueue.Builderclone()
Returns
Type Description
Overrides

getAppEngineHttpTarget()

publicAppEngineHttpTargetgetAppEngineHttpTarget()

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()

publicAppEngineHttpTarget.BuildergetAppEngineHttpTargetBuilder()

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

getAppEngineHttpTargetOrBuilder()

publicAppEngineHttpTargetOrBuildergetAppEngineHttpTargetOrBuilder()

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

getDefaultInstanceForType()

publicQueuegetDefaultInstanceForType()
Returns
Type Description

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Overrides

getName()

publicStringgetName()

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_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
  • LOCATION_ID is 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_ID can 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()

publicByteStringgetNameBytes()

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_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
  • LOCATION_ID is 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_ID can 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()

publicPullTargetgetPullTarget()

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()

publicPullTarget.BuildergetPullTargetBuilder()

Pull target. A pull queue is a queue that has a PullTarget.

.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;

Returns
Type Description

getPullTargetOrBuilder()

publicPullTargetOrBuildergetPullTargetOrBuilder()

Pull target. A pull queue is a queue that has a PullTarget.

.google.cloud.tasks.v2beta2.PullTarget pull_target = 4;

Returns
Type Description

getPurgeTime()

publicTimestampgetPurgeTime()

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()

publicTimestamp.BuildergetPurgeTimeBuilder()

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

getPurgeTimeOrBuilder()

publicTimestampOrBuildergetPurgeTimeOrBuilder()

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

getRateLimits()

publicRateLimitsgetRateLimits()

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()

publicRateLimits.BuildergetRateLimitsBuilder()

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

getRateLimitsOrBuilder()

publicRateLimitsOrBuildergetRateLimitsOrBuilder()

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

getRetryConfig()

publicRetryConfiggetRetryConfig()

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()

publicRetryConfig.BuildergetRetryConfigBuilder()

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

getRetryConfigOrBuilder()

publicRetryConfigOrBuildergetRetryConfigOrBuilder()

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

getState()

publicQueue.StategetState()

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.v2beta2.Queue.State state = 7;

Returns
Type Description
Queue.State

The state.

getStateValue()

publicintgetStateValue()

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.v2beta2.Queue.State state = 7;

Returns
Type Description
int

The enum numeric value on the wire for state.

getStats()

publicQueueStatsgetStats()

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()

publicQueueStats.BuildergetStatsBuilder()

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

getStatsOrBuilder()

publicQueueStatsOrBuildergetStatsOrBuilder()

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

getTargetTypeCase()

publicQueue.TargetTypeCasegetTargetTypeCase()
Returns
Type Description

getTaskTtl()

publicDurationgetTaskTtl()

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()

publicDuration.BuildergetTaskTtlBuilder()

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

getTaskTtlOrBuilder()

publicDurationOrBuildergetTaskTtlOrBuilder()

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

getTombstoneTtl()

publicDurationgetTombstoneTtl()

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()

publicDuration.BuildergetTombstoneTtlBuilder()

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

getTombstoneTtlOrBuilder()

publicDurationOrBuildergetTombstoneTtlOrBuilder()

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

hasAppEngineHttpTarget()

publicbooleanhasAppEngineHttpTarget()

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.

hasPullTarget()

publicbooleanhasPullTarget()

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()

publicbooleanhasPurgeTime()

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()

publicbooleanhasRateLimits()

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()

publicbooleanhasRetryConfig()

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()

publicbooleanhasStats()

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()

publicbooleanhasTaskTtl()

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()

publicbooleanhasTombstoneTtl()

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()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
Overrides

mergeAppEngineHttpTarget(AppEngineHttpTarget value)

publicQueue.BuildermergeAppEngineHttpTarget(AppEngineHttpTargetvalue)

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
Returns
Type Description

mergeFrom(Queue other)

publicQueue.BuildermergeFrom(Queueother)
Parameter
Name Description
other Queue
Returns
Type Description

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicQueue.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Overrides Exceptions
Type Description

mergeFrom(Message other)

publicQueue.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
Overrides

mergePullTarget(PullTarget value)

publicQueue.BuildermergePullTarget(PullTargetvalue)

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

mergePurgeTime(Timestamp value)

publicQueue.BuildermergePurgeTime(Timestampvalue)

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

mergeRateLimits(RateLimits value)

publicQueue.BuildermergeRateLimits(RateLimitsvalue)

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

mergeRetryConfig(RetryConfig value)

publicQueue.BuildermergeRetryConfig(RetryConfigvalue)

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

mergeStats(QueueStats value)

publicQueue.BuildermergeStats(QueueStatsvalue)

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

mergeTaskTtl(Duration value)

publicQueue.BuildermergeTaskTtl(Durationvalue)

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

mergeTombstoneTtl(Duration value)

publicQueue.BuildermergeTombstoneTtl(Durationvalue)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalQueue.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Overrides

setAppEngineHttpTarget(AppEngineHttpTarget value)

publicQueue.BuildersetAppEngineHttpTarget(AppEngineHttpTargetvalue)

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
Returns
Type Description

setAppEngineHttpTarget(AppEngineHttpTarget.Builder builderForValue)

publicQueue.BuildersetAppEngineHttpTarget(AppEngineHttpTarget.BuilderbuilderForValue)

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

setField(Descriptors.FieldDescriptor field, Object value)

publicQueue.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
value Object
Returns
Type Description
Overrides

setName(String value)

publicQueue.BuildersetName(Stringvalue)

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_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
  • LOCATION_ID is 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_ID can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Queue.Builder

This builder for chaining.

setNameBytes(ByteString value)

publicQueue.BuildersetNameBytes(ByteStringvalue)

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_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
  • LOCATION_ID is 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_ID can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Queue.Builder

This builder for chaining.

setPullTarget(PullTarget value)

publicQueue.BuildersetPullTarget(PullTargetvalue)

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

setPullTarget(PullTarget.Builder builderForValue)

publicQueue.BuildersetPullTarget(PullTarget.BuilderbuilderForValue)

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

setPurgeTime(Timestamp value)

publicQueue.BuildersetPurgeTime(Timestampvalue)

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

setPurgeTime(Timestamp.Builder builderForValue)

publicQueue.BuildersetPurgeTime(Timestamp.BuilderbuilderForValue)

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

setRateLimits(RateLimits value)

publicQueue.BuildersetRateLimits(RateLimitsvalue)

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

setRateLimits(RateLimits.Builder builderForValue)

publicQueue.BuildersetRateLimits(RateLimits.BuilderbuilderForValue)

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

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

publicQueue.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
index int
value Object
Returns
Type Description
Overrides

setRetryConfig(RetryConfig value)

publicQueue.BuildersetRetryConfig(RetryConfigvalue)

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

setRetryConfig(RetryConfig.Builder builderForValue)

publicQueue.BuildersetRetryConfig(RetryConfig.BuilderbuilderForValue)

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

setState(Queue.State value)

publicQueue.BuildersetState(Queue.Statevalue)

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.v2beta2.Queue.State state = 7;

Parameter
Name Description
value Queue.State

The state to set.

Returns
Type Description
Queue.Builder

This builder for chaining.

setStateValue(int value)

publicQueue.BuildersetStateValue(intvalue)

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.v2beta2.Queue.State state = 7;

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
Queue.Builder

This builder for chaining.

setStats(QueueStats value)

publicQueue.BuildersetStats(QueueStatsvalue)

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

setStats(QueueStats.Builder builderForValue)

publicQueue.BuildersetStats(QueueStats.BuilderbuilderForValue)

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

setTaskTtl(Duration value)

publicQueue.BuildersetTaskTtl(Durationvalue)

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

setTaskTtl(Duration.Builder builderForValue)

publicQueue.BuildersetTaskTtl(Duration.BuilderbuilderForValue)

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

setTombstoneTtl(Duration value)

publicQueue.BuildersetTombstoneTtl(Durationvalue)

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

setTombstoneTtl(Duration.Builder builderForValue)

publicQueue.BuildersetTombstoneTtl(Duration.BuilderbuilderForValue)

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

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalQueue.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Overrides

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.