QueueArgs

data class QueueArgs(val appEngineHttpTarget: Output<AppEngineHttpTargetArgs>? = null, val httpTarget: Output<HttpTargetArgs>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val pullTarget: Output<PullTargetArgs>? = null, val rateLimits: Output<RateLimitsArgs>? = null, val retryConfig: Output<RetryConfigArgs>? = null, val taskTtl: Output<String>? = null, val tombstoneTtl: Output<String>? = null) : ConvertibleToJava<QueueArgs>

Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine queue.yaml or queue.xml file to manage your queues. Read Overview of Queue Management and queue.yaml before using this method.

Constructors

Link copied to clipboard
fun QueueArgs(appEngineHttpTarget: Output<AppEngineHttpTargetArgs>? = null, httpTarget: Output<HttpTargetArgs>? = null, location: Output<String>? = null, name: Output<String>? = null, project: Output<String>? = null, pullTarget: Output<PullTargetArgs>? = null, rateLimits: Output<RateLimitsArgs>? = null, retryConfig: Output<RetryConfigArgs>? = null, taskTtl: Output<String>? = null, tombstoneTtl: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): QueueArgs

Properties

Link copied to clipboard

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

Link copied to clipboard
val httpTarget: Output<HttpTargetArgs>? = null

An http_target is used to override the target values for HTTP tasks.

Link copied to clipboard
val location: Output<String>? = null
Link copied to clipboard
val name: Output<String>? = null

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.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val pullTarget: Output<PullTargetArgs>? = null

Pull target. A pull queue is a queue that has a PullTarget.

Link copied to clipboard
val rateLimits: Output<RateLimitsArgs>? = null

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

Link copied to clipboard
val retryConfig: Output<RetryConfigArgs>? = null

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.

Link copied to clipboard
val taskTtl: Output<String>? = null

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.

Link copied to clipboard
val tombstoneTtl: Output<String>? = null

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.