Class Queue.Builder (2.3.1)

public static final class Queue.Builder extends GeneratedMessageV3.Builder<Queue.Builder> implements QueueOrBuilder

A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, target types, and others.

Protobuf type google.cloud.tasks.v2beta2.Queue

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Queue.Builder

Implements

QueueOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

public Queue.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
Queue.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getName()

public String getName()

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

public ByteString getNameBytes()

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

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

.google.protobuf.Timestamp purge_time = 8;

Returns

Type	Description
Timestamp	The purgeTime.

getPurgeTimeBuilder()

public Timestamp.Builder getPurgeTimeBuilder()

.google.protobuf.Timestamp purge_time = 8;

Returns

Type	Description
Builder

getPurgeTimeOrBuilder()

public TimestampOrBuilder getPurgeTimeOrBuilder()

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

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

.google.protobuf.Duration task_ttl = 9;

Returns

Type	Description
Duration	The taskTtl.

getTaskTtlBuilder()

public Duration.Builder getTaskTtlBuilder()

.google.protobuf.Duration task_ttl = 9;

Returns

Type	Description
Builder

getTaskTtlOrBuilder()

public DurationOrBuilder getTaskTtlOrBuilder()

.google.protobuf.Duration task_ttl = 9;

Returns

Type	Description
DurationOrBuilder

getTombstoneTtl()

public Duration getTombstoneTtl()

.google.protobuf.Duration tombstone_ttl = 10;

Returns

Type	Description
Duration	The tombstoneTtl.

getTombstoneTtlBuilder()

public Duration.Builder getTombstoneTtlBuilder()

.google.protobuf.Duration tombstone_ttl = 10;

Returns

Type	Description
Builder

getTombstoneTtlOrBuilder()

public DurationOrBuilder getTombstoneTtlOrBuilder()

.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.

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

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

.google.protobuf.Duration task_ttl = 9;

Returns

Type	Description
boolean	Whether the taskTtl field is set.

hasTombstoneTtl()

public boolean hasTombstoneTtl()

.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

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Queue.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
Queue.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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)

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

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

.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

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public Queue.Builder setName(String value)

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)

public Queue.Builder setNameBytes(ByteString value)

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)

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)

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

.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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

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

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)

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

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

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

.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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)