Class: Google::Cloud::Tasks::V2beta3::Queue

Inherits:

Object

• Object
• Google::Cloud::Tasks::V2beta3::Queue

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/tasks/v2beta3/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, Type

Instance Attribute Summary

• #app_engine_http_queue ⇒ ::Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue

  AppEngineHttpQueue settings apply only to [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue.

• #name ⇒ ::String

  Caller-specified and required in CreateQueue, after which it becomes output only.

• #purge_time ⇒ ::Google::Protobuf::Timestamp

  Output only.

• #rate_limits ⇒ ::Google::Cloud::Tasks::V2beta3::RateLimits

  Rate limits for task dispatches.

• #retry_config ⇒ ::Google::Cloud::Tasks::V2beta3::RetryConfig

  Settings that determine the retry behavior.

• #stackdriver_logging_config ⇒ ::Google::Cloud::Tasks::V2beta3::StackdriverLoggingConfig

  Configuration options for writing logs to Stackdriver Logging.

• #state ⇒ ::Google::Cloud::Tasks::V2beta3::Queue::State

  Output only.

• #stats ⇒ ::Google::Cloud::Tasks::V2beta3::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).

• #type ⇒ ::Google::Cloud::Tasks::V2beta3::Queue::Type

  Immutable.

Instance Attribute Details

#app_engine_http_queue ⇒ ::Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue

# File 'proto_docs/google/cloud/tasks/v2beta3/queue.rb', line 166

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::V2beta3::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end

  # The type of the queue.
  module Type
    # Default value.
    TYPE_UNSPECIFIED = 0

    # A pull queue.
    PULL = 1

    # A push queue.
    PUSH = 2
  end
end

#name ⇒ ::String

# File 'proto_docs/google/cloud/tasks/v2beta3/queue.rb', line 166

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::V2beta3::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end

  # The type of the queue.
  module Type
    # Default value.
    TYPE_UNSPECIFIED = 0

    # A pull queue.
    PULL = 1

    # A push queue.
    PUSH = 2
  end
end

#purge_time ⇒ ::Google::Protobuf::Timestamp

# File 'proto_docs/google/cloud/tasks/v2beta3/queue.rb', line 166

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::V2beta3::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end

  # The type of the queue.
  module Type
    # Default value.
    TYPE_UNSPECIFIED = 0

    # A pull queue.
    PULL = 1

    # A push queue.
    PUSH = 2
  end
end

#rate_limits ⇒ ::Google::Cloud::Tasks::V2beta3::RateLimits

# File 'proto_docs/google/cloud/tasks/v2beta3/queue.rb', line 166

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::V2beta3::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end

  # The type of the queue.
  module Type
    # Default value.
    TYPE_UNSPECIFIED = 0

    # A pull queue.
    PULL = 1

    # A push queue.
    PUSH = 2
  end
end

#retry_config ⇒ ::Google::Cloud::Tasks::V2beta3::RetryConfig

# File 'proto_docs/google/cloud/tasks/v2beta3/queue.rb', line 166

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::V2beta3::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end

  # The type of the queue.
  module Type
    # Default value.
    TYPE_UNSPECIFIED = 0

    # A pull queue.
    PULL = 1

    # A push queue.
    PUSH = 2
  end
end

#stackdriver_logging_config ⇒ ::Google::Cloud::Tasks::V2beta3::StackdriverLoggingConfig

# File 'proto_docs/google/cloud/tasks/v2beta3/queue.rb', line 166

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::V2beta3::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end

  # The type of the queue.
  module Type
    # Default value.
    TYPE_UNSPECIFIED = 0

    # A pull queue.
    PULL = 1

    # A push queue.
    PUSH = 2
  end
end

#state ⇒ ::Google::Cloud::Tasks::V2beta3::Queue::State

# File 'proto_docs/google/cloud/tasks/v2beta3/queue.rb', line 166

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::V2beta3::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end

  # The type of the queue.
  module Type
    # Default value.
    TYPE_UNSPECIFIED = 0

    # A pull queue.
    PULL = 1

    # A push queue.
    PUSH = 2
  end
end

#stats ⇒ ::Google::Cloud::Tasks::V2beta3::QueueStats (readonly)

# File 'proto_docs/google/cloud/tasks/v2beta3/queue.rb', line 166

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::V2beta3::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end

  # The type of the queue.
  module Type
    # Default value.
    TYPE_UNSPECIFIED = 0

    # A pull queue.
    PULL = 1

    # A push queue.
    PUSH = 2
  end
end

#task_ttl ⇒ ::Google::Protobuf::Duration

# File 'proto_docs/google/cloud/tasks/v2beta3/queue.rb', line 166

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::V2beta3::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end

  # The type of the queue.
  module Type
    # Default value.
    TYPE_UNSPECIFIED = 0

    # A pull queue.
    PULL = 1

    # A push queue.
    PUSH = 2
  end
end

#tombstone_ttl ⇒ ::Google::Protobuf::Duration

# File 'proto_docs/google/cloud/tasks/v2beta3/queue.rb', line 166

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::V2beta3::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end

  # The type of the queue.
  module Type
    # Default value.
    TYPE_UNSPECIFIED = 0

    # A pull queue.
    PULL = 1

    # A push queue.
    PUSH = 2
  end
end

#type ⇒ ::Google::Cloud::Tasks::V2beta3::Queue::Type

# File 'proto_docs/google/cloud/tasks/v2beta3/queue.rb', line 166

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::V2beta3::CloudTasks::Client#delete_queue DeleteQueue}.
    DISABLED = 3
  end

  # The type of the queue.
  module Type
    # Default value.
    TYPE_UNSPECIFIED = 0

    # A pull queue.
    PULL = 1

    # A push queue.
    PUSH = 2
  end
end