Class Queue

A named resource to which messages are sent by publishers.

Example Usage - Queue Basic

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var @default = new Gcp.CloudTasks.Queue("default", new Gcp.CloudTasks.QueueArgs
    {
        Location = "us-central1",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Queue

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.CloudTasks

Assembly: Pulumi.Gcp.dll

Syntax

public class Queue : CustomResource

Constructors

Queue(String, QueueArgs, CustomResourceOptions)

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

Declaration

public Queue(string name, QueueArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
QueueArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AppEngineRoutingOverride

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

Declaration

public Output<QueueAppEngineRoutingOverride> AppEngineRoutingOverride { get; }

Property Value

Type	Description
Output<QueueAppEngineRoutingOverride>

Location

The location of the queue

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

The queue name.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Project

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

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

RateLimits

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.

Declaration

public Output<QueueRateLimits> RateLimits { get; }

Property Value

Type	Description
Output<QueueRateLimits>

RetryConfig

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

Declaration

public Output<QueueRetryConfig> RetryConfig { get; }

Property Value

Type	Description
Output<QueueRetryConfig>

Methods

Get(String, Input<String>, QueueState, CustomResourceOptions)

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

Declaration

public static Queue Get(string name, Input<string> id, QueueState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
QueueState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Queue