Class: Google::Cloud::Tasks::V2beta2::Queue

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/tasks/v2beta2/doc/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

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.

Returns:



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb', line 101

class Queue
  # 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 {Google::Rpc::Code::NOT_FOUND 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::LeaseTasks LeaseTasks} calls will return a
    # {Google::Rpc::Code::FAILED_PRECONDITION 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::LeaseTasks LeaseTasks} calls return a
    # +FAILED_PRECONDITION+ error.
    #
    # To permanently delete this queue and all of its tasks, call
    # {Google::Cloud::Tasks::V2beta2::CloudTasks::DeleteQueue 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 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 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:

  • (String) —

    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
    • +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 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.


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb', line 101

class Queue
  # 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 {Google::Rpc::Code::NOT_FOUND 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::LeaseTasks LeaseTasks} calls will return a
    # {Google::Rpc::Code::FAILED_PRECONDITION 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::LeaseTasks LeaseTasks} calls return a
    # +FAILED_PRECONDITION+ error.
    #
    # To permanently delete this queue and all of its tasks, call
    # {Google::Cloud::Tasks::V2beta2::CloudTasks::DeleteQueue 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.

Returns:



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb', line 101

class Queue
  # 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 {Google::Rpc::Code::NOT_FOUND 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::LeaseTasks LeaseTasks} calls will return a
    # {Google::Rpc::Code::FAILED_PRECONDITION 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::LeaseTasks LeaseTasks} calls return a
    # +FAILED_PRECONDITION+ error.
    #
    # To permanently delete this queue and all of its tasks, call
    # {Google::Cloud::Tasks::V2beta2::CloudTasks::DeleteQueue 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.

Returns:



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb', line 101

class Queue
  # 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 {Google::Rpc::Code::NOT_FOUND 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::LeaseTasks LeaseTasks} calls will return a
    # {Google::Rpc::Code::FAILED_PRECONDITION 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::LeaseTasks LeaseTasks} calls return a
    # +FAILED_PRECONDITION+ error.
    #
    # To permanently delete this queue and all of its tasks, call
    # {Google::Cloud::Tasks::V2beta2::CloudTasks::DeleteQueue 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).

Returns:

  • (Google::Cloud::Tasks::V2beta2::RateLimits) —

    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).


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb', line 101

class Queue
  # 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 {Google::Rpc::Code::NOT_FOUND 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::LeaseTasks LeaseTasks} calls will return a
    # {Google::Rpc::Code::FAILED_PRECONDITION 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::LeaseTasks LeaseTasks} calls return a
    # +FAILED_PRECONDITION+ error.
    #
    # To permanently delete this queue and all of its tasks, call
    # {Google::Cloud::Tasks::V2beta2::CloudTasks::DeleteQueue 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.

Returns:

  • (Google::Cloud::Tasks::V2beta2::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.


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb', line 101

class Queue
  # 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 {Google::Rpc::Code::NOT_FOUND 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::LeaseTasks LeaseTasks} calls will return a
    # {Google::Rpc::Code::FAILED_PRECONDITION 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::LeaseTasks LeaseTasks} calls return a
    # +FAILED_PRECONDITION+ error.
    #
    # To permanently delete this queue and all of its tasks, call
    # {Google::Cloud::Tasks::V2beta2::CloudTasks::DeleteQueue 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+.

Returns:



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb', line 101

class Queue
  # 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 {Google::Rpc::Code::NOT_FOUND 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::LeaseTasks LeaseTasks} calls will return a
    # {Google::Rpc::Code::FAILED_PRECONDITION 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::LeaseTasks LeaseTasks} calls return a
    # +FAILED_PRECONDITION+ error.
    #
    # To permanently delete this queue and all of its tasks, call
    # {Google::Cloud::Tasks::V2beta2::CloudTasks::DeleteQueue DeleteQueue}.
    DISABLED = 3
  end
end