cloudtasks¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.

class pulumi_gcp.cloudtasks.Queue(resource_name, opts=None, app_engine_routing_override=None, location=None, name=None, project=None, rate_limits=None, retry_config=None, __props__=None, __name__=None, __opts__=None)¶

A named resource to which messages are sent by publishers.

import pulumi
import pulumi_gcp as gcp

default = gcp.cloudtasks.Queue("default", location="us-central1")

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• app_engine_routing_override (pulumi.Input[dict]) – Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.

• location (pulumi.Input[str]) – The location of the queue

• name (pulumi.Input[str]) – The queue name.

• project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

• rate_limits (pulumi.Input[dict]) – Rate limits for task dispatches. The queue’s actual dispatch rate is the result of:

* Number of tasks in the queue
* User-specified throttling: rateLimits, retryConfig, 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.  Structure is documented below.

Parameters

retry_config (pulumi.Input[dict]) – Settings that determine the retry behavior. Structure is documented below.

The app_engine_routing_override object supports the following:

• host (pulumi.Input[str]) - - The host that the task is sent to.

• instance (pulumi.Input[str]) - App instance. By default, the task is sent to an instance which is available when the task is attempted.

• service (pulumi.Input[str]) - App service. By default, the task is sent to the service which is the default service when the task is attempted.

• version (pulumi.Input[str]) - App version. By default, the task is sent to the version which is the default version when the task is attempted.

The rate_limits object supports the following:

• maxBurstSize (pulumi.Input[float]) - - The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.

• maxConcurrentDispatches (pulumi.Input[float]) - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.

• maxDispatchesPerSecond (pulumi.Input[float]) - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.

The retry_config object supports the following:

• maxAttempts (pulumi.Input[float]) - Number of attempts per task. Cloud Tasks will attempt the task maxAttempts times (that is, if the first attempt fails, then there will be maxAttempts - 1 retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts.

• maxBackoff (pulumi.Input[str]) - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.

• maxDoublings (pulumi.Input[float]) - The time between retries will double maxDoublings times. A task’s retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoff up to maxAttempts times.

• maxRetryDuration (pulumi.Input[str]) - If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.

• minBackoff (pulumi.Input[str]) - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.

app_engine_routing_override: pulumi.Output[dict] = None¶

Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.

• host (str) - - The host that the task is sent to.

• instance (str) - App instance. By default, the task is sent to an instance which is available when the task is attempted.

• service (str) - App service. By default, the task is sent to the service which is the default service when the task is attempted.

• version (str) - App version. By default, the task is sent to the version which is the default version when the task is attempted.

location: pulumi.Output[str] = None¶

The location of the queue

name: pulumi.Output[str] = None¶

The queue name.

project: pulumi.Output[str] = None¶

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

rate_limits: pulumi.Output[dict] = None¶

Rate limits for task dispatches. The queue’s actual dispatch rate is the result of:

• Number of tasks in the queue

• User-specified throttling: rateLimits, retryConfig, 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. Structure is documented below.

  • maxBurstSize (float) - - The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.

  • maxConcurrentDispatches (float) - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.

  • maxDispatchesPerSecond (float) - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.

retry_config: pulumi.Output[dict] = None¶

Settings that determine the retry behavior. Structure is documented below.

• maxAttempts (float) - Number of attempts per task. Cloud Tasks will attempt the task maxAttempts times (that is, if the first attempt fails, then there will be maxAttempts - 1 retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts.

• maxBackoff (str) - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.

• maxDoublings (float) - The time between retries will double maxDoublings times. A task’s retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoff up to maxAttempts times.

• maxRetryDuration (str) - If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.

• minBackoff (str) - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.

static get(resource_name, id, opts=None, app_engine_routing_override=None, location=None, name=None, project=None, rate_limits=None, retry_config=None)¶

Get an existing Queue resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• app_engine_routing_override (pulumi.Input[dict]) – Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue Structure is documented below.

• location (pulumi.Input[str]) – The location of the queue

• name (pulumi.Input[str]) – The queue name.

• project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

• rate_limits (pulumi.Input[dict]) – Rate limits for task dispatches. The queue’s actual dispatch rate is the result of:

* Number of tasks in the queue
* User-specified throttling: rateLimits, retryConfig, 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.  Structure is documented below.

Parameters

retry_config (pulumi.Input[dict]) – Settings that determine the retry behavior. Structure is documented below.

The app_engine_routing_override object supports the following:

• host (pulumi.Input[str]) - - The host that the task is sent to.

• instance (pulumi.Input[str]) - App instance. By default, the task is sent to an instance which is available when the task is attempted.

• service (pulumi.Input[str]) - App service. By default, the task is sent to the service which is the default service when the task is attempted.

• version (pulumi.Input[str]) - App version. By default, the task is sent to the version which is the default version when the task is attempted.

The rate_limits object supports the following:

• maxBurstSize (pulumi.Input[float]) - - The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.

• maxConcurrentDispatches (pulumi.Input[float]) - The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.

• maxDispatchesPerSecond (pulumi.Input[float]) - The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.

The retry_config object supports the following:

• maxAttempts (pulumi.Input[float]) - Number of attempts per task. Cloud Tasks will attempt the task maxAttempts times (that is, if the first attempt fails, then there will be maxAttempts - 1 retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts.

• maxBackoff (pulumi.Input[str]) - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.

• maxDoublings (pulumi.Input[float]) - The time between retries will double maxDoublings times. A task’s retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoff up to maxAttempts times.

• maxRetryDuration (pulumi.Input[str]) - If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.

• minBackoff (pulumi.Input[str]) - A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str