Class: Google::Cloud::Tasks::V2::Queue

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/tasks/v2/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, queue types, and others.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#app_engine_routing_override::Google::Cloud::Tasks::V2::AppEngineRouting



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'proto_docs/google/cloud/tasks/v2/queue.rb', line 125

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.
    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.
    #
    # To permanently delete this queue and all of its tasks, call
    # {::Google::Cloud::Tasks::V2::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end
end

#name::String



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'proto_docs/google/cloud/tasks/v2/queue.rb', line 125

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.
    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.
    #
    # To permanently delete this queue and all of its tasks, call
    # {::Google::Cloud::Tasks::V2::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end
end

#purge_time::Google::Protobuf::Timestamp



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'proto_docs/google/cloud/tasks/v2/queue.rb', line 125

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.
    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.
    #
    # To permanently delete this queue and all of its tasks, call
    # {::Google::Cloud::Tasks::V2::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end
end

#rate_limits::Google::Cloud::Tasks::V2::RateLimits



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'proto_docs/google/cloud/tasks/v2/queue.rb', line 125

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.
    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.
    #
    # To permanently delete this queue and all of its tasks, call
    # {::Google::Cloud::Tasks::V2::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end
end

#retry_config::Google::Cloud::Tasks::V2::RetryConfig



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'proto_docs/google/cloud/tasks/v2/queue.rb', line 125

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.
    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.
    #
    # To permanently delete this queue and all of its tasks, call
    # {::Google::Cloud::Tasks::V2::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end
end

#stackdriver_logging_config::Google::Cloud::Tasks::V2::StackdriverLoggingConfig



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'proto_docs/google/cloud/tasks/v2/queue.rb', line 125

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.
    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.
    #
    # To permanently delete this queue and all of its tasks, call
    # {::Google::Cloud::Tasks::V2::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end
end

#state::Google::Cloud::Tasks::V2::Queue::State



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'proto_docs/google/cloud/tasks/v2/queue.rb', line 125

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.
    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.
    #
    # To permanently delete this queue and all of its tasks, call
    # {::Google::Cloud::Tasks::V2::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end
end