class Google::Apis::CloudtasksV2::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 Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](cloud.google.com/ appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google
App Engine](cloud.google.com/appengine/docs/python/ microservices-on-app-engine), [App Engine Standard request routing](https:// cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [ App Engine Flex request routing](cloud.google.com/appengine/docs/ flexible/python/how-requests-are-routed). Using AppEngineRouting
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 `appEngineRoutingOverride` @return [Google::Apis::CloudtasksV2::AppEngineRouting]
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::CloudtasksV2::RateLimits]
Retry config. These settings determine when a failed task attempt is retried. Corresponds to the JSON property `retryConfig` @return [Google::Apis::CloudtasksV2::RetryConfig]
Configuration options for writing logs to [Stackdriver Logging](cloud. google.com/logging/docs/). Corresponds to the JSON property `stackdriverLoggingConfig` @return [Google::Apis::CloudtasksV2::StackdriverLoggingConfig]
Output only. The state of the queue. `state` can only be changed by calling 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]
Public Class Methods
# File lib/google/apis/cloudtasks_v2/classes.rb, line 942 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/cloudtasks_v2/classes.rb, line 947 def update!(**args) @app_engine_routing_override = args[:app_engine_routing_override] if args.key?(:app_engine_routing_override) @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) end