Class Queue (2.42.0)

public final class Queue extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Queue

Implements

QueueOrBuilder

Static Fields

APP_ENGINE_HTTP_TARGET_FIELD_NUMBER

public static final int APP_ENGINE_HTTP_TARGET_FIELD_NUMBER
Field Value
Type Description
int

HTTP_TARGET_FIELD_NUMBER

public static final int HTTP_TARGET_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PULL_TARGET_FIELD_NUMBER

public static final int PULL_TARGET_FIELD_NUMBER
Field Value
Type Description
int

PURGE_TIME_FIELD_NUMBER

public static final int PURGE_TIME_FIELD_NUMBER
Field Value
Type Description
int

RATE_LIMITS_FIELD_NUMBER

public static final int RATE_LIMITS_FIELD_NUMBER
Field Value
Type Description
int

RETRY_CONFIG_FIELD_NUMBER

public static final int RETRY_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STATS_FIELD_NUMBER

public static final int STATS_FIELD_NUMBER
Field Value
Type Description
int

TASK_TTL_FIELD_NUMBER

public static final int TASK_TTL_FIELD_NUMBER
Field Value
Type Description
int

TOMBSTONE_TTL_FIELD_NUMBER

public static final int TOMBSTONE_TTL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Queue getDefaultInstance()
Returns
Type Description
Queue

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Queue.Builder newBuilder()
Returns
Type Description
Queue.Builder

newBuilder(Queue prototype)

public static Queue.Builder newBuilder(Queue prototype)
Parameter
Name Description
prototype Queue
Returns
Type Description
Queue.Builder

parseDelimitedFrom(InputStream input)

public static Queue parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Queue
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Queue parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Queue
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Queue parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Queue
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Queue parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Queue
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Queue parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Queue
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Queue parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Queue
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Queue parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Queue
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Queue parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Queue
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Queue parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Queue
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Queue parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Queue
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Queue parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Queue
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Queue parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Queue
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Queue> parser()
Returns
Type Description
Parser<Queue>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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

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.

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

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.

getParserForType()

public Parser<Queue> getParserForType()
Returns
Type Description
Parser<Queue>
Overrides

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.

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.

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.

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Queue.Builder newBuilderForType()
Returns
Type Description
Queue.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Queue.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Queue.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Queue.Builder toBuilder()
Returns
Type Description
Queue.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException