1. Docs
2. Reference
3. API
4. @pulumi/gcp
5. cloudtasks

Module cloudtasks

Resources

• Queue

Others

• QueueArgs
• QueueState

Resources

Resource Queue

class Queue extends CustomResource

A named resource to which messages are sent by publishers.

Example Usage - Queue Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const defaultQueue = new gcp.cloudtasks.Queue("default", {
    location: "us-central1",
});

constructor

new Queue(name: string, args: QueueArgs, opts?: pulumi.CustomResourceOptions)

Create a Queue resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QueueState, opts?: pulumi.CustomResourceOptions): Queue

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Queue

Returns true if the given object is an instance of Queue. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property appEngineRoutingOverride

public appEngineRoutingOverride: pulumi.Output<QueueAppEngineRoutingOverride | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

The location of the queue

property name

public name: pulumi.Output<string>;

The queue name.

property project

public project: pulumi.Output<string>;

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

property rateLimits

public rateLimits: pulumi.Output<QueueRateLimits>;

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.

property retryConfig

public retryConfig: pulumi.Output<QueueRetryConfig>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface QueueArgs

interface QueueArgs

The set of arguments for constructing a Queue resource.

property appEngineRoutingOverride

appEngineRoutingOverride?: pulumi.Input<QueueAppEngineRoutingOverride>;

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

property location

location: pulumi.Input<string>;

The location of the queue

property name

name?: pulumi.Input<string>;

The queue name.

property project

project?: pulumi.Input<string>;

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

property rateLimits

rateLimits?: pulumi.Input<QueueRateLimits>;

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.

property retryConfig

retryConfig?: pulumi.Input<QueueRetryConfig>;

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

interface QueueState

interface QueueState

Input properties used for looking up and filtering Queue resources.

property appEngineRoutingOverride

appEngineRoutingOverride?: pulumi.Input<QueueAppEngineRoutingOverride>;

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

property location

location?: pulumi.Input<string>;

The location of the queue

property name

name?: pulumi.Input<string>;

The queue name.

property project

project?: pulumi.Input<string>;

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

property rateLimits

rateLimits?: pulumi.Input<QueueRateLimits>;

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.

property retryConfig

retryConfig?: pulumi.Input<QueueRetryConfig>;

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