Class Queue (2.9.0)

Queue(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name	Description
name	`str` 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
app_engine_http_queue	`google.cloud.tasks_v2beta3.types.AppEngineHttpQueue` AppEngineHttpQueue settings apply only to [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue. [Http tasks][google.cloud.tasks.v2beta3.HttpRequest] are not affected by this proto. This field is a member of `oneof`_ ``queue_type``.
rate_limits	`google.cloud.tasks_v2beta3.types.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][google.cloud.tasks.v2beta3.Queue.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.
retry_config	`google.cloud.tasks_v2beta3.types.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	`google.cloud.tasks_v2beta3.types.Queue.State` Output only. The state of the queue. ``state`` can only be changed by calling PauseQueue, ResumeQueue, or uploading `queue.yaml/xml
purge_time	`google.protobuf.timestamp_pb2.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
task_ttl	`google.protobuf.duration_pb2.Duration` 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
tombstone_ttl	`google.protobuf.duration_pb2.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 ``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.
stackdriver_logging_config	`google.cloud.tasks_v2beta3.types.StackdriverLoggingConfig` Configuration options for writing logs to `Stackdriver Logging
type_	`google.cloud.tasks_v2beta3.types.Queue.Type` 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.
stats	`google.cloud.tasks_v2beta3.types.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.

Inheritance

builtins.object > proto.message.Message > Queue

Classes

State

State(value)

State of the queue.

Type

Type(value)

The type of the queue.