Reference documentation and code samples for the Google Cloud Tasks V2beta3 Client class Queue.
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.
Generated from protobuf message google.cloud.tasks.v2beta3.Queue
Namespace
Google \ Cloud \ Tasks \ V2beta3Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: |
↳ app_engine_http_queue |
Google\Cloud\Tasks\V2beta3\AppEngineHttpQueue
AppEngineHttpQueue settings apply only to App Engine tasks in this queue. Http tasks are not affected by this proto. |
↳ rate_limits |
Google\Cloud\Tasks\V2beta3\RateLimits
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 |
↳ retry_config |
Google\Cloud\Tasks\V2beta3\RetryConfig
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. |
↳ state |
int
Output only. The state of the queue. |
↳ purge_time |
Google\Protobuf\Timestamp
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. |
↳ task_ttl |
Google\Protobuf\Duration
The maximum amount of time that a task will be retained in this queue. Queues created by Cloud Tasks have a default |
↳ tombstone_ttl |
Google\Protobuf\Duration
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 |
↳ stackdriver_logging_config |
Google\Cloud\Tasks\V2beta3\StackdriverLoggingConfig
Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written. |
↳ type |
int
Immutable. The type of a queue (push or pull). |
↳ stats |
Google\Cloud\Tasks\V2beta3\QueueStats
Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask. |
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.
Returns | |
---|---|
Type | Description |
string |
setName
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getAppEngineHttpQueue
AppEngineHttpQueue settings apply only to App Engine tasks in this queue.
Http tasks are not affected by this proto.
Returns | |
---|---|
Type | Description |
Google\Cloud\Tasks\V2beta3\AppEngineHttpQueue|null |
hasAppEngineHttpQueue
setAppEngineHttpQueue
AppEngineHttpQueue settings apply only to App Engine tasks in this queue.
Http tasks are not affected by this proto.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Tasks\V2beta3\AppEngineHttpQueue
|
Returns | |
---|---|
Type | Description |
$this |
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) or503
(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
Returns | |
---|---|
Type | Description |
Google\Cloud\Tasks\V2beta3\RateLimits|null |
hasRateLimits
clearRateLimits
setRateLimits
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) or503
(Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Tasks\V2beta3\RateLimits
|
Returns | |
---|---|
Type | Description |
$this |
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.
Returns | |
---|---|
Type | Description |
Google\Cloud\Tasks\V2beta3\RetryConfig|null |
hasRetryConfig
clearRetryConfig
setRetryConfig
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.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Tasks\V2beta3\RetryConfig
|
Returns | |
---|---|
Type | Description |
$this |
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
.
Returns | |
---|---|
Type | Description |
int |
setState
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
.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasPurgeTime
clearPurgeTime
setPurgeTime
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.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Duration|null |
hasTaskTtl
clearTaskTtl
setTaskTtl
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.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Duration
|
Returns | |
---|---|
Type | Description |
$this |
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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Duration|null |
hasTombstoneTtl
clearTombstoneTtl
setTombstoneTtl
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.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Duration
|
Returns | |
---|---|
Type | Description |
$this |
getStackdriverLoggingConfig
Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
Returns | |
---|---|
Type | Description |
Google\Cloud\Tasks\V2beta3\StackdriverLoggingConfig|null |
hasStackdriverLoggingConfig
clearStackdriverLoggingConfig
setStackdriverLoggingConfig
Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Tasks\V2beta3\StackdriverLoggingConfig
|
Returns | |
---|---|
Type | Description |
$this |
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.
Returns | |
---|---|
Type | Description |
int |
setType
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.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
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.
Returns | |
---|---|
Type | Description |
Google\Cloud\Tasks\V2beta3\QueueStats|null |
hasStats
clearStats
setStats
Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Tasks\V2beta3\QueueStats
|
Returns | |
---|---|
Type | Description |
$this |
getQueueType
Returns | |
---|---|
Type | Description |
string |