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
Implements
Inherited Members
Namespace: Google.Apis.CloudTasks.v2beta3.Data
Assembly: Google.Apis.CloudTasks.v2beta3.dll
Syntax
public class Queue : IDirectResponseSchema

Properties

AppEngineHttpQueue

AppEngineHttpQueue settings apply only to App Engine tasks in this queue. Http tasks are not affected by this proto.

Declaration
[JsonProperty("appEngineHttpQueue")]
public virtual AppEngineHttpQueue AppEngineHttpQueue { get; set; }
Property Value
Type Description
AppEngineHttpQueue

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

HttpTarget

Modifies HTTP target for HTTP tasks.

Declaration
[JsonProperty("httpTarget")]
public virtual HttpTarget HttpTarget { get; set; }
Property Value
Type Description
HttpTarget

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

PurgeTime

object representation of PurgeTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use PurgeTimeDateTimeOffset instead.")]
public virtual object PurgeTime { get; set; }
Property Value
Type Description
object

PurgeTimeDateTimeOffset

DateTimeOffset representation of PurgeTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? PurgeTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

PurgeTimeRaw

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.

Declaration
[JsonProperty("purgeTime")]
public virtual string PurgeTimeRaw { get; set; }
Property Value
Type Description
string

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

Declaration
[JsonProperty("rateLimits")]
public virtual RateLimits RateLimits { get; set; }
Property Value
Type Description
RateLimits

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.

Declaration
[JsonProperty("retryConfig")]
public virtual RetryConfig RetryConfig { get; set; }
Property Value
Type Description
RetryConfig

StackdriverLoggingConfig

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

Declaration
[JsonProperty("stackdriverLoggingConfig")]
public virtual StackdriverLoggingConfig StackdriverLoggingConfig { get; set; }
Property Value
Type Description
StackdriverLoggingConfig

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.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

Stats

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

Declaration
[JsonProperty("stats")]
public virtual QueueStats Stats { get; set; }
Property Value
Type Description
QueueStats

TaskTtl

The maximum amount of time that a task will be retained in this queue. After a task has lived for task_ttl, the task will be deleted regardless of whether it was dispatched or not. The minimum value is 10 days. The maximum value is 10 years. The value must be given as a string that indicates the length of time (in seconds) followed by s (for "seconds"). For more information on the format, see the documentation for Duration. Queues created by Cloud Tasks have a default task_ttl of 31 days. . Queues created by queue.yaml/xml have a fixed task_ttl of the maximum duration, because there is a storage quota for these queues.

Declaration
[JsonProperty("taskTtl")]
public virtual object TaskTtl { get; set; }
Property Value
Type Description
object

TombstoneTtl

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. The minimum value is 1 hour. The maximum value is 9 days. The value must be given as a string that indicates the length of time (in seconds) followed by s (for "seconds"). For more information on the format, see the documentation for Duration. Queues created by Cloud Tasks have a default tombstone_ttl of 1 hour.

Declaration
[JsonProperty("tombstoneTtl")]
public virtual object TombstoneTtl { get; set; }
Property Value
Type Description
object

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.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

Implements