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

Inherits:

Object

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

show all

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 collapse

#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.
#http_target ⇒ ::Google::Cloud::Tasks::V2beta3::HttpTarget
Modifies HTTP target for HTTP tasks.
#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`

Returns AppEngineHttpQueue settings apply only to [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue. Http tasks are not affected by this proto.

Returns:

(::Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue) —
AppEngineHttpQueue settings apply only to [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue. Http tasks are not affected by this proto.

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

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

#http_target ⇒ `::Google::Cloud::Tasks::V2beta3::HttpTarget`

Returns Modifies HTTP target for HTTP tasks.

Returns:

(::Google::Cloud::Tasks::V2beta3::HttpTarget) —
Modifies HTTP target for HTTP tasks.

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

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`

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

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

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

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`

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:

(::Google::Protobuf::Timestamp) —
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.

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

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`

Returns Rate limits for task dispatches.

rate_limits and retry_config are related because they both control task attempts. However they control task attempts 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).

The queue's actual dispatch rate is the result of:

Number of tasks in the queue
User-specified throttling: rate_limits, retry_config, and the [queue's state][google.cloud.tasks.v2beta3.Queue.state].
System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.

Returns:

(::Google::Cloud::Tasks::V2beta3::RateLimits) —
Rate limits for task dispatches.

rate_limits and retry_config are related because they both control task attempts. However they control task attempts 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).
The queue's actual dispatch rate is the result of:
- Number of tasks in the queue
- User-specified throttling: rate_limits, retry_config, and the [queue's state][google.cloud.tasks.v2beta3.Queue.state].
- System throttling due to 429 (Too Many Requests) or 503 (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.

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

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`

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::V2beta3::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.

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

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`

Returns Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.

Returns:

(::Google::Cloud::Tasks::V2beta3::StackdriverLoggingConfig) —
Configuration options for writing logs to Stackdriver Logging. If this field is unset, then no logs are written.

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

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`

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:

(::Google::Cloud::Tasks::V2beta3::Queue::State) —
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.

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

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)

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.

Returns:

(::Google::Cloud::Tasks::V2beta3::QueueStats) —
Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.

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

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`

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.

Returns:

(::Google::Protobuf::Duration) —
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.

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

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`

Returns The task tombstone time to live (TTL).

After a task is deleted or executed, 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.

Returns:

(::Google::Protobuf::Duration) —
The task tombstone time to live (TTL).

After a task is deleted or executed, 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.

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

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`

Returns Immutable. The type of a queue (push or pull).

Queue.type is an immutable property of the queue that is set at the queue creation time. When left unspecified, the default value of PUSH is selected.

Returns:

(::Google::Cloud::Tasks::V2beta3::Queue::Type) —
Immutable. The type of a queue (push or pull).

Queue.type is an immutable property of the queue that is set at the queue creation time. When left unspecified, the default value of PUSH is selected.

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

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

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

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

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

#http_target ⇒ ::Google::Cloud::Tasks::V2beta3::HttpTarget

#name ⇒ ::String

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

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

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

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

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

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

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

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

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

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

#http_target ⇒ `::Google::Cloud::Tasks::V2beta3::HttpTarget`

#name ⇒ `::String`

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

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

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

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

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

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

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

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

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