Class: Google::Cloud::Tasks::V2beta2::Queue
- Inherits:
-
Object
- Object
- Google::Cloud::Tasks::V2beta2::Queue
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/tasks/v2beta2/queue.rb
Overview
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, target types, and others.
Defined Under Namespace
Modules: State
Instance Attribute Summary collapse
-
#app_engine_http_target ⇒ ::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget
App Engine HTTP target.
-
#http_target ⇒ ::Google::Cloud::Tasks::V2beta2::HttpTarget
An http_target is used to override the target values for HTTP tasks.
-
#name ⇒ ::String
Caller-specified and required in CreateQueue, after which it becomes output only.
-
#pull_target ⇒ ::Google::Cloud::Tasks::V2beta2::PullTarget
Pull target.
-
#purge_time ⇒ ::Google::Protobuf::Timestamp
Output only.
-
#rate_limits ⇒ ::Google::Cloud::Tasks::V2beta2::RateLimits
Rate limits for task dispatches.
-
#retry_config ⇒ ::Google::Cloud::Tasks::V2beta2::RetryConfig
Settings that determine the retry behavior.
-
#state ⇒ ::Google::Cloud::Tasks::V2beta2::Queue::State
Output only.
-
#stats ⇒ ::Google::Cloud::Tasks::V2beta2::QueueStats
readonly
Output only.
-
#task_ttl ⇒ ::Google::Protobuf::Duration
The maximum amount of time that a task will be retained in this queue.
-
#tombstone_ttl ⇒ ::Google::Protobuf::Duration
The task tombstone time to live (TTL).
Instance Attribute Details
#app_engine_http_target ⇒ ::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget
Returns App Engine HTTP target.
An App Engine queue is a queue that has an AppEngineHttpTarget.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'proto_docs/google/cloud/tasks/v2beta2/queue.rb', line 151 class Queue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the queue. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The queue is running. Tasks can be dispatched. # # If the queue was created using Cloud Tasks and the queue has # had no activity (method calls or task dispatches) for 30 days, # the queue may take a few minutes to re-activate. Some method # calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and # tasks may not be dispatched for a few minutes until the queue # has been re-activated. RUNNING = 1 # Tasks are paused by the user. If the queue is paused then Cloud # Tasks will stop delivering tasks from it, but more tasks can # still be added to it by the user. When a pull queue is paused, # all {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]. PAUSED = 2 # The queue is disabled. # # A queue becomes `DISABLED` when # [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) # or # [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) # is uploaded which does not contain the queue. You cannot directly disable # a queue. # # When a queue is disabled, tasks can still be added to a queue # but the tasks are not dispatched and # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # return a `FAILED_PRECONDITION` error. # # To permanently delete this queue and all of its tasks, call # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}. DISABLED = 3 end end |
#http_target ⇒ ::Google::Cloud::Tasks::V2beta2::HttpTarget
Returns An http_target is used to override the target values for HTTP tasks.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'proto_docs/google/cloud/tasks/v2beta2/queue.rb', line 151 class Queue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the queue. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The queue is running. Tasks can be dispatched. # # If the queue was created using Cloud Tasks and the queue has # had no activity (method calls or task dispatches) for 30 days, # the queue may take a few minutes to re-activate. Some method # calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and # tasks may not be dispatched for a few minutes until the queue # has been re-activated. RUNNING = 1 # Tasks are paused by the user. If the queue is paused then Cloud # Tasks will stop delivering tasks from it, but more tasks can # still be added to it by the user. When a pull queue is paused, # all {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]. PAUSED = 2 # The queue is disabled. # # A queue becomes `DISABLED` when # [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) # or # [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) # is uploaded which does not contain the queue. You cannot directly disable # a queue. # # When a queue is disabled, tasks can still be added to a queue # but the tasks are not dispatched and # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # return a `FAILED_PRECONDITION` error. # # To permanently delete this queue and all of its tasks, call # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}. DISABLED = 3 end end |
#name ⇒ ::String
Returns 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::Google::Cloud::Location::Locations::Client#list_locations
. 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.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'proto_docs/google/cloud/tasks/v2beta2/queue.rb', line 151 class Queue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the queue. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The queue is running. Tasks can be dispatched. # # If the queue was created using Cloud Tasks and the queue has # had no activity (method calls or task dispatches) for 30 days, # the queue may take a few minutes to re-activate. Some method # calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and # tasks may not be dispatched for a few minutes until the queue # has been re-activated. RUNNING = 1 # Tasks are paused by the user. If the queue is paused then Cloud # Tasks will stop delivering tasks from it, but more tasks can # still be added to it by the user. When a pull queue is paused, # all {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]. PAUSED = 2 # The queue is disabled. # # A queue becomes `DISABLED` when # [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) # or # [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) # is uploaded which does not contain the queue. You cannot directly disable # a queue. # # When a queue is disabled, tasks can still be added to a queue # but the tasks are not dispatched and # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # return a `FAILED_PRECONDITION` error. # # To permanently delete this queue and all of its tasks, call # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}. DISABLED = 3 end end |
#pull_target ⇒ ::Google::Cloud::Tasks::V2beta2::PullTarget
Returns Pull target.
A pull queue is a queue that has a PullTarget.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'proto_docs/google/cloud/tasks/v2beta2/queue.rb', line 151 class Queue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the queue. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The queue is running. Tasks can be dispatched. # # If the queue was created using Cloud Tasks and the queue has # had no activity (method calls or task dispatches) for 30 days, # the queue may take a few minutes to re-activate. Some method # calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and # tasks may not be dispatched for a few minutes until the queue # has been re-activated. RUNNING = 1 # Tasks are paused by the user. If the queue is paused then Cloud # Tasks will stop delivering tasks from it, but more tasks can # still be added to it by the user. When a pull queue is paused, # all {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]. PAUSED = 2 # The queue is disabled. # # A queue becomes `DISABLED` when # [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) # or # [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) # is uploaded which does not contain the queue. You cannot directly disable # a queue. # # When a queue is disabled, tasks can still be added to a queue # but the tasks are not dispatched and # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # return a `FAILED_PRECONDITION` error. # # To permanently delete this queue and all of its tasks, call # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}. DISABLED = 3 end end |
#purge_time ⇒ ::Google::Protobuf::Timestamp
Returns 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.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'proto_docs/google/cloud/tasks/v2beta2/queue.rb', line 151 class Queue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the queue. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The queue is running. Tasks can be dispatched. # # If the queue was created using Cloud Tasks and the queue has # had no activity (method calls or task dispatches) for 30 days, # the queue may take a few minutes to re-activate. Some method # calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and # tasks may not be dispatched for a few minutes until the queue # has been re-activated. RUNNING = 1 # Tasks are paused by the user. If the queue is paused then Cloud # Tasks will stop delivering tasks from it, but more tasks can # still be added to it by the user. When a pull queue is paused, # all {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]. PAUSED = 2 # The queue is disabled. # # A queue becomes `DISABLED` when # [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) # or # [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) # is uploaded which does not contain the queue. You cannot directly disable # a queue. # # When a queue is disabled, tasks can still be added to a queue # but the tasks are not dispatched and # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # return a `FAILED_PRECONDITION` error. # # To permanently delete this queue and all of its tasks, call # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}. DISABLED = 3 end end |
#rate_limits ⇒ ::Google::Cloud::Tasks::V2beta2::RateLimits
Returns Rate limits for task dispatches.
rate_limits and retry_config are related because they both control task attempts however they control how tasks are attempted 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).
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'proto_docs/google/cloud/tasks/v2beta2/queue.rb', line 151 class Queue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the queue. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The queue is running. Tasks can be dispatched. # # If the queue was created using Cloud Tasks and the queue has # had no activity (method calls or task dispatches) for 30 days, # the queue may take a few minutes to re-activate. Some method # calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and # tasks may not be dispatched for a few minutes until the queue # has been re-activated. RUNNING = 1 # Tasks are paused by the user. If the queue is paused then Cloud # Tasks will stop delivering tasks from it, but more tasks can # still be added to it by the user. When a pull queue is paused, # all {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]. PAUSED = 2 # The queue is disabled. # # A queue becomes `DISABLED` when # [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) # or # [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) # is uploaded which does not contain the queue. You cannot directly disable # a queue. # # When a queue is disabled, tasks can still be added to a queue # but the tasks are not dispatched and # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # return a `FAILED_PRECONDITION` error. # # To permanently delete this queue and all of its tasks, call # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}. DISABLED = 3 end end |
#retry_config ⇒ ::Google::Cloud::Tasks::V2beta2::RetryConfig
Returns 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.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'proto_docs/google/cloud/tasks/v2beta2/queue.rb', line 151 class Queue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the queue. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The queue is running. Tasks can be dispatched. # # If the queue was created using Cloud Tasks and the queue has # had no activity (method calls or task dispatches) for 30 days, # the queue may take a few minutes to re-activate. Some method # calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and # tasks may not be dispatched for a few minutes until the queue # has been re-activated. RUNNING = 1 # Tasks are paused by the user. If the queue is paused then Cloud # Tasks will stop delivering tasks from it, but more tasks can # still be added to it by the user. When a pull queue is paused, # all {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]. PAUSED = 2 # The queue is disabled. # # A queue becomes `DISABLED` when # [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) # or # [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) # is uploaded which does not contain the queue. You cannot directly disable # a queue. # # When a queue is disabled, tasks can still be added to a queue # but the tasks are not dispatched and # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # return a `FAILED_PRECONDITION` error. # # To permanently delete this queue and all of its tasks, call # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}. DISABLED = 3 end end |
#state ⇒ ::Google::Cloud::Tasks::V2beta2::Queue::State
Returns Output only. The state of the queue.
state
can only be changed by called
PauseQueue,
ResumeQueue, or
uploading
queue.yaml/xml.
UpdateQueue cannot be
used to change state
.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'proto_docs/google/cloud/tasks/v2beta2/queue.rb', line 151 class Queue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the queue. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The queue is running. Tasks can be dispatched. # # If the queue was created using Cloud Tasks and the queue has # had no activity (method calls or task dispatches) for 30 days, # the queue may take a few minutes to re-activate. Some method # calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and # tasks may not be dispatched for a few minutes until the queue # has been re-activated. RUNNING = 1 # Tasks are paused by the user. If the queue is paused then Cloud # Tasks will stop delivering tasks from it, but more tasks can # still be added to it by the user. When a pull queue is paused, # all {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]. PAUSED = 2 # The queue is disabled. # # A queue becomes `DISABLED` when # [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) # or # [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) # is uploaded which does not contain the queue. You cannot directly disable # a queue. # # When a queue is disabled, tasks can still be added to a queue # but the tasks are not dispatched and # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # return a `FAILED_PRECONDITION` error. # # To permanently delete this queue and all of its tasks, call # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}. DISABLED = 3 end end |
#stats ⇒ ::Google::Cloud::Tasks::V2beta2::QueueStats (readonly)
Returns Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'proto_docs/google/cloud/tasks/v2beta2/queue.rb', line 151 class Queue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the queue. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The queue is running. Tasks can be dispatched. # # If the queue was created using Cloud Tasks and the queue has # had no activity (method calls or task dispatches) for 30 days, # the queue may take a few minutes to re-activate. Some method # calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and # tasks may not be dispatched for a few minutes until the queue # has been re-activated. RUNNING = 1 # Tasks are paused by the user. If the queue is paused then Cloud # Tasks will stop delivering tasks from it, but more tasks can # still be added to it by the user. When a pull queue is paused, # all {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]. PAUSED = 2 # The queue is disabled. # # A queue becomes `DISABLED` when # [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) # or # [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) # is uploaded which does not contain the queue. You cannot directly disable # a queue. # # When a queue is disabled, tasks can still be added to a queue # but the tasks are not dispatched and # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # return a `FAILED_PRECONDITION` error. # # To permanently delete this queue and all of its tasks, call # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}. DISABLED = 3 end end |
#task_ttl ⇒ ::Google::Protobuf::Duration
Returns 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.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'proto_docs/google/cloud/tasks/v2beta2/queue.rb', line 151 class Queue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the queue. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The queue is running. Tasks can be dispatched. # # If the queue was created using Cloud Tasks and the queue has # had no activity (method calls or task dispatches) for 30 days, # the queue may take a few minutes to re-activate. Some method # calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and # tasks may not be dispatched for a few minutes until the queue # has been re-activated. RUNNING = 1 # Tasks are paused by the user. If the queue is paused then Cloud # Tasks will stop delivering tasks from it, but more tasks can # still be added to it by the user. When a pull queue is paused, # all {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]. PAUSED = 2 # The queue is disabled. # # A queue becomes `DISABLED` when # [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) # or # [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) # is uploaded which does not contain the queue. You cannot directly disable # a queue. # # When a queue is disabled, tasks can still be added to a queue # but the tasks are not dispatched and # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # return a `FAILED_PRECONDITION` error. # # To permanently delete this queue and all of its tasks, call # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}. DISABLED = 3 end end |
#tombstone_ttl ⇒ ::Google::Protobuf::Duration
Returns The task tombstone time to live (TTL).
After a task is deleted or completed, 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.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'proto_docs/google/cloud/tasks/v2beta2/queue.rb', line 151 class Queue include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # State of the queue. module State # Unspecified state. STATE_UNSPECIFIED = 0 # The queue is running. Tasks can be dispatched. # # If the queue was created using Cloud Tasks and the queue has # had no activity (method calls or task dispatches) for 30 days, # the queue may take a few minutes to re-activate. Some method # calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and # tasks may not be dispatched for a few minutes until the queue # has been re-activated. RUNNING = 1 # Tasks are paused by the user. If the queue is paused then Cloud # Tasks will stop delivering tasks from it, but more tasks can # still be added to it by the user. When a pull queue is paused, # all {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]. PAUSED = 2 # The queue is disabled. # # A queue becomes `DISABLED` when # [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) # or # [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) # is uploaded which does not contain the queue. You cannot directly disable # a queue. # # When a queue is disabled, tasks can still be added to a queue # but the tasks are not dispatched and # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls # return a `FAILED_PRECONDITION` error. # # To permanently delete this queue and all of its tasks, call # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}. DISABLED = 3 end end |