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, queue types, and others.
Protobuf type google.cloud.tasks.v2beta3.Queue
Static Fields
APP_ENGINE_HTTP_QUEUE_FIELD_NUMBER
public static final int APP_ENGINE_HTTP_QUEUE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_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 | |
STACKDRIVER_LOGGING_CONFIG_FIELD_NUMBER
public static final int STACKDRIVER_LOGGING_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 | |
TYPE_FIELD_NUMBER
public static final int TYPE_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()
newBuilder()
public static Queue.Builder newBuilder()
newBuilder(Queue prototype)
public static Queue.Builder newBuilder(Queue prototype)
| Parameter |
|---|
| Name | Description |
prototype | Queue
|
public static Queue parseDelimitedFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Queue | |
public static Queue parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Queue | |
parseFrom(byte[] data)
public static Queue parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Queue | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Queue parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Queue | |
parseFrom(ByteString data)
public static Queue parseFrom(ByteString data)
| Returns |
|---|
| Type | Description |
Queue | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Queue parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Queue | |
public static Queue parseFrom(CodedInputStream input)
| Returns |
|---|
| Type | Description |
Queue | |
public static Queue parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Queue | |
public static Queue parseFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Queue | |
public static Queue parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Queue | |
parseFrom(ByteBuffer data)
public static Queue parseFrom(ByteBuffer data)
| Returns |
|---|
| Type | Description |
Queue | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Queue parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Queue | |
parser()
public static Parser<Queue> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAppEngineHttpQueue()
public AppEngineHttpQueue getAppEngineHttpQueue()
AppEngineHttpQueue
settings apply only to App Engine
tasks in this queue.
Http tasks are not affected by
this proto.
.google.cloud.tasks.v2beta3.AppEngineHttpQueue app_engine_http_queue = 3;
getAppEngineHttpQueueOrBuilder()
public AppEngineHttpQueueOrBuilder getAppEngineHttpQueueOrBuilder()
AppEngineHttpQueue
settings apply only to App Engine
tasks in this queue.
Http tasks are not affected by
this proto.
.google.cloud.tasks.v2beta3.AppEngineHttpQueue app_engine_http_queue = 3;
getDefaultInstanceForType()
public Queue getDefaultInstanceForType()
| Returns |
|---|
| Type | Description |
Queue | |
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
projectsLOCATION_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
projectsLOCATION_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()
Overrides
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 = 7;
| 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 = 7;
getQueueTypeCase()
public Queue.QueueTypeCase getQueueTypeCase()
getRateLimits()
public RateLimits getRateLimits()
Rate limits for task dispatches.
rate_limits and
retry_config are related
because they both control task attempts. However they control task attempts
in different ways:
- rate_limits controls the
total rate of
dispatches from a queue (i.e. all traffic dispatched from the
queue, regardless of whether the dispatch is from a first
attempt or a retry).
- retry_config controls
what happens to
particular a task after its first attempt fails. That is,
retry_config controls
task retries (the second attempt, third attempt, etc).
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling:
rate_limits,
retry_config, and the
queue's state.
- System throttling due to
429 (Too Many Requests) or 503 (Service
Unavailable) responses from the worker, high error rates, or to smooth
sudden large traffic spikes.
.google.cloud.tasks.v2beta3.RateLimits rate_limits = 4;
getRateLimitsOrBuilder()
public RateLimitsOrBuilder getRateLimitsOrBuilder()
Rate limits for task dispatches.
rate_limits and
retry_config are related
because they both control task attempts. However they control task attempts
in different ways:
- rate_limits controls the
total rate of
dispatches from a queue (i.e. all traffic dispatched from the
queue, regardless of whether the dispatch is from a first
attempt or a retry).
- retry_config controls
what happens to
particular a task after its first attempt fails. That is,
retry_config controls
task retries (the second attempt, third attempt, etc).
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling:
rate_limits,
retry_config, and the
queue's state.
- System throttling due to
429 (Too Many Requests) or 503 (Service
Unavailable) responses from the worker, high error rates, or to smooth
sudden large traffic spikes.
.google.cloud.tasks.v2beta3.RateLimits rate_limits = 4;
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.v2beta3.RetryConfig retry_config = 5;
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.v2beta3.RetryConfig retry_config = 5;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getStackdriverLoggingConfig()
public StackdriverLoggingConfig getStackdriverLoggingConfig()
Configuration options for writing logs to
Stackdriver Logging. If this
field is unset, then no logs are written.
.google.cloud.tasks.v2beta3.StackdriverLoggingConfig stackdriver_logging_config = 10;
getStackdriverLoggingConfigOrBuilder()
public StackdriverLoggingConfigOrBuilder getStackdriverLoggingConfigOrBuilder()
Configuration options for writing logs to
Stackdriver Logging. If this
field is unset, then no logs are written.
.google.cloud.tasks.v2beta3.StackdriverLoggingConfig stackdriver_logging_config = 10;
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.v2beta3.Queue.State state = 6;
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.v2beta3.Queue.State state = 6;
| 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.v2beta3.QueueStats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.v2beta3.QueueStats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
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 = 8;
| 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 = 8;
getTombstoneTtl()
public Duration getTombstoneTtl()
The task tombstone time to live (TTL).
After a task is deleted or executed, 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 = 9;
| Returns |
|---|
| Type | Description |
Duration | The tombstoneTtl.
|
getTombstoneTtlOrBuilder()
public DurationOrBuilder getTombstoneTtlOrBuilder()
The task tombstone time to live (TTL).
After a task is deleted or executed, 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 = 9;
getType()
public Queue.Type getType()
Immutable. The type of a queue (push or pull).
Queue.type is an immutable property of the queue that is set at the queue
creation time. When left unspecified, the default value of PUSH is
selected.
.google.cloud.tasks.v2beta3.Queue.Type type = 11 [(.google.api.field_behavior) = IMMUTABLE];
getTypeValue()
public int getTypeValue()
Immutable. The type of a queue (push or pull).
Queue.type is an immutable property of the queue that is set at the queue
creation time. When left unspecified, the default value of PUSH is
selected.
.google.cloud.tasks.v2beta3.Queue.Type type = 11 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for type.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hasAppEngineHttpQueue()
public boolean hasAppEngineHttpQueue()
AppEngineHttpQueue
settings apply only to App Engine
tasks in this queue.
Http tasks are not affected by
this proto.
.google.cloud.tasks.v2beta3.AppEngineHttpQueue app_engine_http_queue = 3;
| Returns |
|---|
| Type | Description |
boolean | Whether the appEngineHttpQueue 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 = 7;
| Returns |
|---|
| Type | Description |
boolean | Whether the purgeTime field is set.
|
hasRateLimits()
public boolean hasRateLimits()
Rate limits for task dispatches.
rate_limits and
retry_config are related
because they both control task attempts. However they control task attempts
in different ways:
- rate_limits controls the
total rate of
dispatches from a queue (i.e. all traffic dispatched from the
queue, regardless of whether the dispatch is from a first
attempt or a retry).
- retry_config controls
what happens to
particular a task after its first attempt fails. That is,
retry_config controls
task retries (the second attempt, third attempt, etc).
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling:
rate_limits,
retry_config, and the
queue's state.
- System throttling due to
429 (Too Many Requests) or 503 (Service
Unavailable) responses from the worker, high error rates, or to smooth
sudden large traffic spikes.
.google.cloud.tasks.v2beta3.RateLimits rate_limits = 4;
| 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.v2beta3.RetryConfig retry_config = 5;
| Returns |
|---|
| Type | Description |
boolean | Whether the retryConfig field is set.
|
hasStackdriverLoggingConfig()
public boolean hasStackdriverLoggingConfig()
Configuration options for writing logs to
Stackdriver Logging. If this
field is unset, then no logs are written.
.google.cloud.tasks.v2beta3.StackdriverLoggingConfig stackdriver_logging_config = 10;
| Returns |
|---|
| Type | Description |
boolean | Whether the stackdriverLoggingConfig 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.v2beta3.QueueStats stats = 12 [(.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 = 8;
| 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 executed, 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 = 9;
| Returns |
|---|
| Type | Description |
boolean | Whether the tombstoneTtl field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Queue.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Queue.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Queue.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
