class Google::Apis::CloudtasksV2beta3::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.
Attributes
App Engine HTTP queue. The task will be delivered to the App Engine application hostname specified by its AppEngineHttpQueue
and AppEngineHttpRequest
. The documentation for AppEngineHttpRequest
explains how the task's host URL is constructed. Using AppEngineHttpQueue
requires [` appengine.applications.get`](cloud.google.com/appengine/docs/admin-api/ access-control) Google
IAM permission for the project and the following scope: `www.googleapis.com/auth/cloud-platform` Corresponds to the JSON property `appEngineHttpQueue` @return [Google::Apis::CloudtasksV2beta3::AppEngineHttpQueue]
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](cloud.google.com/ resource-manager/docs/creating-managing-projects#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 cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. Corresponds to the JSON property `name` @return [String]
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](cloud.google.com/ appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues# purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. Corresponds to the JSON property `purgeTime` @return [String]
Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits
. Corresponds to the JSON property `rateLimits` @return [Google::Apis::CloudtasksV2beta3::RateLimits]
Retry config. These settings determine when a failed task attempt is retried. Corresponds to the JSON property `retryConfig` @return [Google::Apis::CloudtasksV2beta3::RetryConfig]
Configuration options for writing logs to [Stackdriver Logging](cloud. google.com/logging/docs/). Corresponds to the JSON property `stackdriverLoggingConfig` @return [Google::Apis::CloudtasksV2beta3::StackdriverLoggingConfig]
Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](cloud.google. com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`. Corresponds to the JSON property `state` @return [String]
Statistics for a queue. Corresponds to the JSON property `stats` @return [Google::Apis::CloudtasksV2beta3::QueueStats]
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](cloud. google.com/appengine/quotas#Task_Queue) for these queues. To view the maximum valid duration, see the documentation for Duration. Corresponds to the JSON property `taskTtl` @return [String]
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. Corresponds to the JSON property `tombstoneTtl` @return [String]
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. Corresponds to the JSON property `type` @return [String]
Public Class Methods
# File lib/google/apis/cloudtasks_v2beta3/classes.rb, line 1032 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/cloudtasks_v2beta3/classes.rb, line 1037 def update!(**args) @app_engine_http_queue = args[:app_engine_http_queue] if args.key?(:app_engine_http_queue) @name = args[:name] if args.key?(:name) @purge_time = args[:purge_time] if args.key?(:purge_time) @rate_limits = args[:rate_limits] if args.key?(:rate_limits) @retry_config = args[:retry_config] if args.key?(:retry_config) @stackdriver_logging_config = args[:stackdriver_logging_config] if args.key?(:stackdriver_logging_config) @state = args[:state] if args.key?(:state) @stats = args[:stats] if args.key?(:stats) @task_ttl = args[:task_ttl] if args.key?(:task_ttl) @tombstone_ttl = args[:tombstone_ttl] if args.key?(:tombstone_ttl) @type = args[:type] if args.key?(:type) end