Google Cloud Tasks v2beta3 API - Class Queue (3.0.0-beta06) 

public sealed class Queue : IMessage<Queue>, IEquatable<Queue>, IDeepCloneable<Queue>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Tasks v2beta3 API class 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, queue types, and others.

Inheritance

object > Queue

Namespace

Google.Cloud.Tasks.V2Beta3

Assembly

Google.Cloud.Tasks.V2Beta3.dll

Constructors

Queue()

public Queue()

Queue(Queue)

public Queue(Queue other)
Parameter
Name Description
other Queue

Properties

AppEngineHttpQueue

public AppEngineHttpQueue AppEngineHttpQueue { get; set; }

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

Property Value
Type Description
AppEngineHttpQueue

HttpTarget

public HttpTarget HttpTarget { get; set; }

Modifies HTTP target for HTTP tasks.

Property Value
Type Description
HttpTarget

Name

public string Name { get; set; }

Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.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.
Property Value
Type Description
string

PurgeTime

public Timestamp PurgeTime { get; set; }

Output only. The last time this queue was purged.

All tasks that were [created][google.cloud.tasks.v2beta3.Task.create_time] before this time were purged.

A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta3.CloudTasks.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.

Property Value
Type Description
Timestamp

QueueName

public QueueName QueueName { get; set; }

QueueName-typed view over the Name resource name property.

Property Value
Type Description
QueueName

QueueTypeCase

public Queue.QueueTypeOneofCase QueueTypeCase { get; }
Property Value
Type Description
QueueQueueTypeOneofCase

RateLimits

public RateLimits RateLimits { get; set; }

Rate limits for task dispatches.

[rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits] and [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] are related because they both control task attempts. However they control task attempts in different ways:

  • [rate_limits][google.cloud.tasks.v2beta3.Queue.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][google.cloud.tasks.v2beta3.Queue.retry_config] controls what happens to particular a task after its first attempt fails. That is, [retry_config][google.cloud.tasks.v2beta3.Queue.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][google.cloud.tasks.v2beta3.Queue.rate_limits], [retry_config][google.cloud.tasks.v2beta3.Queue.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.
Property Value
Type Description
RateLimits

RetryConfig

public RetryConfig RetryConfig { get; set; }

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.
Property Value
Type Description
RetryConfig

StackdriverLoggingConfig

public StackdriverLoggingConfig StackdriverLoggingConfig { get; set; }

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

Property Value
Type Description
StackdriverLoggingConfig

State

public Queue.Types.State State { get; set; }

Output only. The state of the queue.

state can only be changed by called [PauseQueue][google.cloud.tasks.v2beta3.CloudTasks.PauseQueue], [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue], or uploading queue.yaml/xml. [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue] cannot be used to change state.

Property Value
Type Description
QueueTypesState

Stats

public QueueStats Stats { get; set; }

Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask.

Property Value
Type Description
QueueStats

TaskTtl

public Duration TaskTtl { get; set; }

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][google.protobuf.Duration].

Property Value
Type Description
Duration

TombstoneTtl

public Duration TombstoneTtl { get; set; }

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][google.cloud.tasks.v2beta3.CreateTaskRequest.task].

Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.

Property Value
Type Description
Duration

Type

public Queue.Types.Type Type { get; set; }

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.

Property Value
Type Description
QueueTypesType