Cloud Tasks V2beta2 API - Class Google::Cloud::Tasks::V2beta2::Queue (v0.9.0)

Reference documentation and code samples for the Cloud Tasks V2beta2 API class Google::Cloud::Tasks::V2beta2::Queue.

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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#app_engine_http_target

def app_engine_http_target() -> ::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget

Returns

(::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget) — App Engine HTTP target.

An App Engine queue is a queue that has an AppEngineHttpTarget.

#app_engine_http_target=

def app_engine_http_target=(value) -> ::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget

Parameter

value (::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget) — App Engine HTTP target.

An App Engine queue is a queue that has an AppEngineHttpTarget.

Returns

(::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget) — App Engine HTTP target.

An App Engine queue is a queue that has an AppEngineHttpTarget.

#name

def name() -> ::String

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][google.cloud.location.Locations.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.

#name=

def name=(value) -> ::String

Parameter

value (::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][google.cloud.location.Locations.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][google.cloud.location.Locations.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.

#pull_target

def pull_target() -> ::Google::Cloud::Tasks::V2beta2::PullTarget

Returns

(::Google::Cloud::Tasks::V2beta2::PullTarget) — Pull target.

A pull queue is a queue that has a PullTarget.

#pull_target=

def pull_target=(value) -> ::Google::Cloud::Tasks::V2beta2::PullTarget

Parameter

value (::Google::Cloud::Tasks::V2beta2::PullTarget) — Pull target.

A pull queue is a queue that has a PullTarget.

Returns

(::Google::Cloud::Tasks::V2beta2::PullTarget) — Pull target.

A pull queue is a queue that has a PullTarget.

#purge_time

def purge_time() -> ::Google::Protobuf::Timestamp

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.

#purge_time=

def purge_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

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

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.

#rate_limits

def rate_limits() -> ::Google::Cloud::Tasks::V2beta2::RateLimits

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

#rate_limits=

def rate_limits=(value) -> ::Google::Cloud::Tasks::V2beta2::RateLimits

Parameter

value (::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).

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

#retry_config

def retry_config() -> ::Google::Cloud::Tasks::V2beta2::RetryConfig

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.

#retry_config=

def retry_config=(value) -> ::Google::Cloud::Tasks::V2beta2::RetryConfig

Parameter

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

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.

#state

def state() -> ::Google::Cloud::Tasks::V2beta2::Queue::State

Returns

(::Google::Cloud::Tasks::V2beta2::Queue::State) — Output only. The state of the queue.

state can only be changed by calling PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change state.

#state=

def state=(value) -> ::Google::Cloud::Tasks::V2beta2::Queue::State

Parameter

value (::Google::Cloud::Tasks::V2beta2::Queue::State) — Output only. The state of the queue.

state can only be changed by calling PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change state.

Returns

(::Google::Cloud::Tasks::V2beta2::Queue::State) — Output only. The state of the queue.

state can only be changed by calling PauseQueue, ResumeQueue, or uploading queue.yaml/xml. UpdateQueue cannot be used to change state.

#stats

def stats() -> ::Google::Cloud::Tasks::V2beta2::QueueStats

Returns

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

#task_ttl

def task_ttl() -> ::Google::Protobuf::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.

#task_ttl=

def task_ttl=(value) -> ::Google::Protobuf::Duration

Parameter

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

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.

#tombstone_ttl

def tombstone_ttl() -> ::Google::Protobuf::Duration

Returns

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

#tombstone_ttl=

def tombstone_ttl=(value) -> ::Google::Protobuf::Duration

Parameter

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

Returns

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