cloudtasks

package
v5.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 1, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Queue 

type Queue struct {
	pulumi.CustomResourceState

	// Overrides for task-level appEngineRouting. These settings apply only
	// to App Engine tasks in this queue
	// Structure is documented below.
	AppEngineRoutingOverride QueueAppEngineRoutingOverridePtrOutput `pulumi:"appEngineRoutingOverride"`
	// The location of the queue
	Location pulumi.StringOutput `pulumi:"location"`
	// The queue name.
	Name pulumi.StringOutput `pulumi:"name"`
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringOutput `pulumi:"project"`
	// 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.
	RateLimits QueueRateLimitsOutput `pulumi:"rateLimits"`
	// Settings that determine the retry behavior.
	// Structure is documented below.
	RetryConfig QueueRetryConfigOutput `pulumi:"retryConfig"`
	// Configuration options for writing logs to Stackdriver Logging.
	// Structure is documented below.
	StackdriverLoggingConfig QueueStackdriverLoggingConfigPtrOutput `pulumi:"stackdriverLoggingConfig"`
}

A named resource to which messages are sent by publishers.

> **Warning:** This resource requires an App Engine application to be created on the project you're provisioning it on. If you haven't already enabled it, you can create a `appengine.Application` resource to do so. This resource's location will be the same as the App Engine location specified.

## Example Usage ### Queue Basic

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v5/go/gcp/cloudtasks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudtasks.NewQueue(ctx, "_default", &cloudtasks.QueueArgs{
			Location: pulumi.String("us-central1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Cloud Tasks Queue Advanced

```go package main

import ( 

"github.com/pulumi/pulumi-gcp/sdk/v5/go/gcp/cloudtasks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudtasks.NewQueue(ctx, "advancedConfiguration", &cloudtasks.QueueArgs{
			AppEngineRoutingOverride: &cloudtasks.QueueAppEngineRoutingOverrideArgs{
				Instance: pulumi.String("test"),
				Service:  pulumi.String("worker"),
				Version:  pulumi.String("1.0"),
			},
			Location: pulumi.String("us-central1"),
			RateLimits: &cloudtasks.QueueRateLimitsArgs{
				MaxConcurrentDispatches: pulumi.Int(3),
				MaxDispatchesPerSecond:  pulumi.Float64(2),
			},
			RetryConfig: &cloudtasks.QueueRetryConfigArgs{
				MaxAttempts:      pulumi.Int(5),
				MaxBackoff:       pulumi.String("3s"),
				MaxDoublings:     pulumi.Int(1),
				MaxRetryDuration: pulumi.String("4s"),
				MinBackoff:       pulumi.String("2s"),
			},
			StackdriverLoggingConfig: &cloudtasks.QueueStackdriverLoggingConfigArgs{
				SamplingRatio: pulumi.Float64(0.9),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Queue can be imported using any of these accepted formats

```sh 

$ pulumi import gcp:cloudtasks/queue:Queue default projects/{{project}}/locations/{{location}}/queues/{{name}}

```

```sh 

$ pulumi import gcp:cloudtasks/queue:Queue default {{project}}/{{location}}/{{name}}

```

```sh 

$ pulumi import gcp:cloudtasks/queue:Queue default {{location}}/{{name}}

```

func GetQueue 

func GetQueue(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *QueueState, opts ...pulumi.ResourceOption) (*Queue, error)

GetQueue gets an existing Queue resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewQueue 

func NewQueue(ctx *pulumi.Context,
	name string, args *QueueArgs, opts ...pulumi.ResourceOption) (*Queue, error)

NewQueue registers a new resource with the given unique name, arguments, and options.

func (*Queue) ElementType 

func (*Queue) ElementType() reflect.Type

func (*Queue) ToQueueOutput 

func (i *Queue) ToQueueOutput() QueueOutput

func (*Queue) ToQueueOutputWithContext 

func (i *Queue) ToQueueOutputWithContext(ctx context.Context) QueueOutput

func (*Queue) ToQueuePtrOutput 

func (i *Queue) ToQueuePtrOutput() QueuePtrOutput

func (*Queue) ToQueuePtrOutputWithContext 

func (i *Queue) ToQueuePtrOutputWithContext(ctx context.Context) QueuePtrOutput

type QueueAppEngineRoutingOverride 

type QueueAppEngineRoutingOverride struct {
	// -
	// The host that the task is sent to.
	Host *string `pulumi:"host"`
	// App instance.
	// By default, the task is sent to an instance which is available when the task is attempted.
	Instance *string `pulumi:"instance"`
	// App service.
	// By default, the task is sent to the service which is the default service when the task is attempted.
	Service *string `pulumi:"service"`
	// App version.
	// By default, the task is sent to the version which is the default version when the task is attempted.
	Version *string `pulumi:"version"`
}

type QueueAppEngineRoutingOverrideArgs 

type QueueAppEngineRoutingOverrideArgs struct {
	// -
	// The host that the task is sent to.
	Host pulumi.StringPtrInput `pulumi:"host"`
	// App instance.
	// By default, the task is sent to an instance which is available when the task is attempted.
	Instance pulumi.StringPtrInput `pulumi:"instance"`
	// App service.
	// By default, the task is sent to the service which is the default service when the task is attempted.
	Service pulumi.StringPtrInput `pulumi:"service"`
	// App version.
	// By default, the task is sent to the version which is the default version when the task is attempted.
	Version pulumi.StringPtrInput `pulumi:"version"`
}

func (QueueAppEngineRoutingOverrideArgs) ElementType 

func (QueueAppEngineRoutingOverrideArgs) ElementType() reflect.Type

func (QueueAppEngineRoutingOverrideArgs) ToQueueAppEngineRoutingOverrideOutput 

func (i QueueAppEngineRoutingOverrideArgs) ToQueueAppEngineRoutingOverrideOutput() QueueAppEngineRoutingOverrideOutput

func (QueueAppEngineRoutingOverrideArgs) ToQueueAppEngineRoutingOverrideOutputWithContext 

func (i QueueAppEngineRoutingOverrideArgs) ToQueueAppEngineRoutingOverrideOutputWithContext(ctx context.Context) QueueAppEngineRoutingOverrideOutput

func (QueueAppEngineRoutingOverrideArgs) ToQueueAppEngineRoutingOverridePtrOutput 

func (i QueueAppEngineRoutingOverrideArgs) ToQueueAppEngineRoutingOverridePtrOutput() QueueAppEngineRoutingOverridePtrOutput

func (QueueAppEngineRoutingOverrideArgs) ToQueueAppEngineRoutingOverridePtrOutputWithContext 

func (i QueueAppEngineRoutingOverrideArgs) ToQueueAppEngineRoutingOverridePtrOutputWithContext(ctx context.Context) QueueAppEngineRoutingOverridePtrOutput

type QueueAppEngineRoutingOverrideInput 

type QueueAppEngineRoutingOverrideInput interface {
	pulumi.Input

	ToQueueAppEngineRoutingOverrideOutput() QueueAppEngineRoutingOverrideOutput
	ToQueueAppEngineRoutingOverrideOutputWithContext(context.Context) QueueAppEngineRoutingOverrideOutput
}

QueueAppEngineRoutingOverrideInput is an input type that accepts QueueAppEngineRoutingOverrideArgs and QueueAppEngineRoutingOverrideOutput values. You can construct a concrete instance of `QueueAppEngineRoutingOverrideInput` via: 

QueueAppEngineRoutingOverrideArgs{...}

type QueueAppEngineRoutingOverrideOutput 

type QueueAppEngineRoutingOverrideOutput struct{ *pulumi.OutputState }

func (QueueAppEngineRoutingOverrideOutput) ElementType 

func (QueueAppEngineRoutingOverrideOutput) ElementType() reflect.Type

func (QueueAppEngineRoutingOverrideOutput) Host 

func (o QueueAppEngineRoutingOverrideOutput) Host() pulumi.StringPtrOutput

- The host that the task is sent to.

func (QueueAppEngineRoutingOverrideOutput) Instance 

func (o QueueAppEngineRoutingOverrideOutput) Instance() pulumi.StringPtrOutput

App instance. By default, the task is sent to an instance which is available when the task is attempted.

func (QueueAppEngineRoutingOverrideOutput) Service 

func (o QueueAppEngineRoutingOverrideOutput) Service() pulumi.StringPtrOutput

App service. By default, the task is sent to the service which is the default service when the task is attempted.

func (QueueAppEngineRoutingOverrideOutput) ToQueueAppEngineRoutingOverrideOutput 

func (o QueueAppEngineRoutingOverrideOutput) ToQueueAppEngineRoutingOverrideOutput() QueueAppEngineRoutingOverrideOutput

func (QueueAppEngineRoutingOverrideOutput) ToQueueAppEngineRoutingOverrideOutputWithContext 

func (o QueueAppEngineRoutingOverrideOutput) ToQueueAppEngineRoutingOverrideOutputWithContext(ctx context.Context) QueueAppEngineRoutingOverrideOutput

func (QueueAppEngineRoutingOverrideOutput) ToQueueAppEngineRoutingOverridePtrOutput 

func (o QueueAppEngineRoutingOverrideOutput) ToQueueAppEngineRoutingOverridePtrOutput() QueueAppEngineRoutingOverridePtrOutput

func (QueueAppEngineRoutingOverrideOutput) ToQueueAppEngineRoutingOverridePtrOutputWithContext 

func (o QueueAppEngineRoutingOverrideOutput) ToQueueAppEngineRoutingOverridePtrOutputWithContext(ctx context.Context) QueueAppEngineRoutingOverridePtrOutput

func (QueueAppEngineRoutingOverrideOutput) Version 

func (o QueueAppEngineRoutingOverrideOutput) Version() pulumi.StringPtrOutput

App version. By default, the task is sent to the version which is the default version when the task is attempted.

type QueueAppEngineRoutingOverridePtrInput 

type QueueAppEngineRoutingOverridePtrInput interface {
	pulumi.Input

	ToQueueAppEngineRoutingOverridePtrOutput() QueueAppEngineRoutingOverridePtrOutput
	ToQueueAppEngineRoutingOverridePtrOutputWithContext(context.Context) QueueAppEngineRoutingOverridePtrOutput
}

QueueAppEngineRoutingOverridePtrInput is an input type that accepts QueueAppEngineRoutingOverrideArgs, QueueAppEngineRoutingOverridePtr and QueueAppEngineRoutingOverridePtrOutput values. You can construct a concrete instance of `QueueAppEngineRoutingOverridePtrInput` via: 

        QueueAppEngineRoutingOverrideArgs{...}

or:

        nil

func QueueAppEngineRoutingOverridePtr 

func QueueAppEngineRoutingOverridePtr(v *QueueAppEngineRoutingOverrideArgs) QueueAppEngineRoutingOverridePtrInput

type QueueAppEngineRoutingOverridePtrOutput 

type QueueAppEngineRoutingOverridePtrOutput struct{ *pulumi.OutputState }

func (QueueAppEngineRoutingOverridePtrOutput) Elem 

func (o QueueAppEngineRoutingOverridePtrOutput) Elem() QueueAppEngineRoutingOverrideOutput

func (QueueAppEngineRoutingOverridePtrOutput) ElementType 

func (QueueAppEngineRoutingOverridePtrOutput) ElementType() reflect.Type

func (QueueAppEngineRoutingOverridePtrOutput) Host 

func (o QueueAppEngineRoutingOverridePtrOutput) Host() pulumi.StringPtrOutput

- The host that the task is sent to.

func (QueueAppEngineRoutingOverridePtrOutput) Instance 

func (o QueueAppEngineRoutingOverridePtrOutput) Instance() pulumi.StringPtrOutput

App instance. By default, the task is sent to an instance which is available when the task is attempted.

func (QueueAppEngineRoutingOverridePtrOutput) Service 

func (o QueueAppEngineRoutingOverridePtrOutput) Service() pulumi.StringPtrOutput

App service. By default, the task is sent to the service which is the default service when the task is attempted.

func (QueueAppEngineRoutingOverridePtrOutput) ToQueueAppEngineRoutingOverridePtrOutput 

func (o QueueAppEngineRoutingOverridePtrOutput) ToQueueAppEngineRoutingOverridePtrOutput() QueueAppEngineRoutingOverridePtrOutput

func (QueueAppEngineRoutingOverridePtrOutput) ToQueueAppEngineRoutingOverridePtrOutputWithContext 

func (o QueueAppEngineRoutingOverridePtrOutput) ToQueueAppEngineRoutingOverridePtrOutputWithContext(ctx context.Context) QueueAppEngineRoutingOverridePtrOutput

func (QueueAppEngineRoutingOverridePtrOutput) Version 

func (o QueueAppEngineRoutingOverridePtrOutput) Version() pulumi.StringPtrOutput

App version. By default, the task is sent to the version which is the default version when the task is attempted.

type QueueArgs 

type QueueArgs struct {
	// Overrides for task-level appEngineRouting. These settings apply only
	// to App Engine tasks in this queue
	// Structure is documented below.
	AppEngineRoutingOverride QueueAppEngineRoutingOverridePtrInput
	// The location of the queue
	Location pulumi.StringInput
	// The queue name.
	Name pulumi.StringPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// 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.
	RateLimits QueueRateLimitsPtrInput
	// Settings that determine the retry behavior.
	// Structure is documented below.
	RetryConfig QueueRetryConfigPtrInput
	// Configuration options for writing logs to Stackdriver Logging.
	// Structure is documented below.
	StackdriverLoggingConfig QueueStackdriverLoggingConfigPtrInput
}

The set of arguments for constructing a Queue resource.

func (QueueArgs) ElementType 

func (QueueArgs) ElementType() reflect.Type

type QueueArray 

type QueueArray []QueueInput

func (QueueArray) ElementType 

func (QueueArray) ElementType() reflect.Type

func (QueueArray) ToQueueArrayOutput 

func (i QueueArray) ToQueueArrayOutput() QueueArrayOutput

func (QueueArray) ToQueueArrayOutputWithContext 

func (i QueueArray) ToQueueArrayOutputWithContext(ctx context.Context) QueueArrayOutput

type QueueArrayInput 

type QueueArrayInput interface {
	pulumi.Input

	ToQueueArrayOutput() QueueArrayOutput
	ToQueueArrayOutputWithContext(context.Context) QueueArrayOutput
}

QueueArrayInput is an input type that accepts QueueArray and QueueArrayOutput values. You can construct a concrete instance of `QueueArrayInput` via: 

QueueArray{ QueueArgs{...} }

type QueueArrayOutput 

type QueueArrayOutput struct{ *pulumi.OutputState }

func (QueueArrayOutput) ElementType 

func (QueueArrayOutput) ElementType() reflect.Type

func (QueueArrayOutput) Index 

func (o QueueArrayOutput) Index(i pulumi.IntInput) QueueOutput

func (QueueArrayOutput) ToQueueArrayOutput 

func (o QueueArrayOutput) ToQueueArrayOutput() QueueArrayOutput

func (QueueArrayOutput) ToQueueArrayOutputWithContext 

func (o QueueArrayOutput) ToQueueArrayOutputWithContext(ctx context.Context) QueueArrayOutput

type QueueInput 

type QueueInput interface {
	pulumi.Input

	ToQueueOutput() QueueOutput
	ToQueueOutputWithContext(ctx context.Context) QueueOutput
}

type QueueMap 

type QueueMap map[string]QueueInput

func (QueueMap) ElementType 

func (QueueMap) ElementType() reflect.Type

func (QueueMap) ToQueueMapOutput 

func (i QueueMap) ToQueueMapOutput() QueueMapOutput

func (QueueMap) ToQueueMapOutputWithContext 

func (i QueueMap) ToQueueMapOutputWithContext(ctx context.Context) QueueMapOutput

type QueueMapInput 

type QueueMapInput interface {
	pulumi.Input

	ToQueueMapOutput() QueueMapOutput
	ToQueueMapOutputWithContext(context.Context) QueueMapOutput
}

QueueMapInput is an input type that accepts QueueMap and QueueMapOutput values. You can construct a concrete instance of `QueueMapInput` via: 

QueueMap{ "key": QueueArgs{...} }

type QueueMapOutput 

type QueueMapOutput struct{ *pulumi.OutputState }

func (QueueMapOutput) ElementType 

func (QueueMapOutput) ElementType() reflect.Type

func (QueueMapOutput) MapIndex 

func (o QueueMapOutput) MapIndex(k pulumi.StringInput) QueueOutput

func (QueueMapOutput) ToQueueMapOutput 

func (o QueueMapOutput) ToQueueMapOutput() QueueMapOutput

func (QueueMapOutput) ToQueueMapOutputWithContext 

func (o QueueMapOutput) ToQueueMapOutputWithContext(ctx context.Context) QueueMapOutput

type QueueOutput 

type QueueOutput struct{ *pulumi.OutputState }

func (QueueOutput) ElementType 

func (QueueOutput) ElementType() reflect.Type

func (QueueOutput) ToQueueOutput 

func (o QueueOutput) ToQueueOutput() QueueOutput

func (QueueOutput) ToQueueOutputWithContext 

func (o QueueOutput) ToQueueOutputWithContext(ctx context.Context) QueueOutput

func (QueueOutput) ToQueuePtrOutput 

func (o QueueOutput) ToQueuePtrOutput() QueuePtrOutput

func (QueueOutput) ToQueuePtrOutputWithContext 

func (o QueueOutput) ToQueuePtrOutputWithContext(ctx context.Context) QueuePtrOutput

type QueuePtrInput 

type QueuePtrInput interface {
	pulumi.Input

	ToQueuePtrOutput() QueuePtrOutput
	ToQueuePtrOutputWithContext(ctx context.Context) QueuePtrOutput
}

type QueuePtrOutput 

type QueuePtrOutput struct{ *pulumi.OutputState }

func (QueuePtrOutput) Elem added in v5.21.0 

func (o QueuePtrOutput) Elem() QueueOutput

func (QueuePtrOutput) ElementType 

func (QueuePtrOutput) ElementType() reflect.Type

func (QueuePtrOutput) ToQueuePtrOutput 

func (o QueuePtrOutput) ToQueuePtrOutput() QueuePtrOutput

func (QueuePtrOutput) ToQueuePtrOutputWithContext 

func (o QueuePtrOutput) ToQueuePtrOutputWithContext(ctx context.Context) QueuePtrOutput

type QueueRateLimits 

type QueueRateLimits struct {
	// -
	// 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.
	MaxBurstSize *int `pulumi:"maxBurstSize"`
	// 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.
	MaxConcurrentDispatches *int `pulumi:"maxConcurrentDispatches"`
	// The maximum rate at which tasks are dispatched from this queue.
	// If unspecified when the queue is created, Cloud Tasks will pick the default.
	MaxDispatchesPerSecond *float64 `pulumi:"maxDispatchesPerSecond"`
}

type QueueRateLimitsArgs 

type QueueRateLimitsArgs struct {
	// -
	// 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.
	MaxBurstSize pulumi.IntPtrInput `pulumi:"maxBurstSize"`
	// 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.
	MaxConcurrentDispatches pulumi.IntPtrInput `pulumi:"maxConcurrentDispatches"`
	// The maximum rate at which tasks are dispatched from this queue.
	// If unspecified when the queue is created, Cloud Tasks will pick the default.
	MaxDispatchesPerSecond pulumi.Float64PtrInput `pulumi:"maxDispatchesPerSecond"`
}

func (QueueRateLimitsArgs) ElementType 

func (QueueRateLimitsArgs) ElementType() reflect.Type

func (QueueRateLimitsArgs) ToQueueRateLimitsOutput 

func (i QueueRateLimitsArgs) ToQueueRateLimitsOutput() QueueRateLimitsOutput

func (QueueRateLimitsArgs) ToQueueRateLimitsOutputWithContext 

func (i QueueRateLimitsArgs) ToQueueRateLimitsOutputWithContext(ctx context.Context) QueueRateLimitsOutput

func (QueueRateLimitsArgs) ToQueueRateLimitsPtrOutput 

func (i QueueRateLimitsArgs) ToQueueRateLimitsPtrOutput() QueueRateLimitsPtrOutput

func (QueueRateLimitsArgs) ToQueueRateLimitsPtrOutputWithContext 

func (i QueueRateLimitsArgs) ToQueueRateLimitsPtrOutputWithContext(ctx context.Context) QueueRateLimitsPtrOutput

type QueueRateLimitsInput 

type QueueRateLimitsInput interface {
	pulumi.Input

	ToQueueRateLimitsOutput() QueueRateLimitsOutput
	ToQueueRateLimitsOutputWithContext(context.Context) QueueRateLimitsOutput
}

QueueRateLimitsInput is an input type that accepts QueueRateLimitsArgs and QueueRateLimitsOutput values. You can construct a concrete instance of `QueueRateLimitsInput` via: 

QueueRateLimitsArgs{...}

type QueueRateLimitsOutput 

type QueueRateLimitsOutput struct{ *pulumi.OutputState }

func (QueueRateLimitsOutput) ElementType 

func (QueueRateLimitsOutput) ElementType() reflect.Type

func (QueueRateLimitsOutput) MaxBurstSize 

func (o QueueRateLimitsOutput) MaxBurstSize() pulumi.IntPtrOutput

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

func (QueueRateLimitsOutput) MaxConcurrentDispatches 

func (o QueueRateLimitsOutput) MaxConcurrentDispatches() pulumi.IntPtrOutput

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.

func (QueueRateLimitsOutput) MaxDispatchesPerSecond 

func (o QueueRateLimitsOutput) MaxDispatchesPerSecond() pulumi.Float64PtrOutput

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

func (QueueRateLimitsOutput) ToQueueRateLimitsOutput 

func (o QueueRateLimitsOutput) ToQueueRateLimitsOutput() QueueRateLimitsOutput

func (QueueRateLimitsOutput) ToQueueRateLimitsOutputWithContext 

func (o QueueRateLimitsOutput) ToQueueRateLimitsOutputWithContext(ctx context.Context) QueueRateLimitsOutput

func (QueueRateLimitsOutput) ToQueueRateLimitsPtrOutput 

func (o QueueRateLimitsOutput) ToQueueRateLimitsPtrOutput() QueueRateLimitsPtrOutput

func (QueueRateLimitsOutput) ToQueueRateLimitsPtrOutputWithContext 

func (o QueueRateLimitsOutput) ToQueueRateLimitsPtrOutputWithContext(ctx context.Context) QueueRateLimitsPtrOutput

type QueueRateLimitsPtrInput 

type QueueRateLimitsPtrInput interface {
	pulumi.Input

	ToQueueRateLimitsPtrOutput() QueueRateLimitsPtrOutput
	ToQueueRateLimitsPtrOutputWithContext(context.Context) QueueRateLimitsPtrOutput
}

QueueRateLimitsPtrInput is an input type that accepts QueueRateLimitsArgs, QueueRateLimitsPtr and QueueRateLimitsPtrOutput values. You can construct a concrete instance of `QueueRateLimitsPtrInput` via: 

        QueueRateLimitsArgs{...}

or:

        nil

func QueueRateLimitsPtr 

func QueueRateLimitsPtr(v *QueueRateLimitsArgs) QueueRateLimitsPtrInput

type QueueRateLimitsPtrOutput 

type QueueRateLimitsPtrOutput struct{ *pulumi.OutputState }

func (QueueRateLimitsPtrOutput) Elem 

func (o QueueRateLimitsPtrOutput) Elem() QueueRateLimitsOutput

func (QueueRateLimitsPtrOutput) ElementType 

func (QueueRateLimitsPtrOutput) ElementType() reflect.Type

func (QueueRateLimitsPtrOutput) MaxBurstSize 

func (o QueueRateLimitsPtrOutput) MaxBurstSize() pulumi.IntPtrOutput

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

func (QueueRateLimitsPtrOutput) MaxConcurrentDispatches 

func (o QueueRateLimitsPtrOutput) MaxConcurrentDispatches() pulumi.IntPtrOutput

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.

func (QueueRateLimitsPtrOutput) MaxDispatchesPerSecond 

func (o QueueRateLimitsPtrOutput) MaxDispatchesPerSecond() pulumi.Float64PtrOutput

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

func (QueueRateLimitsPtrOutput) ToQueueRateLimitsPtrOutput 

func (o QueueRateLimitsPtrOutput) ToQueueRateLimitsPtrOutput() QueueRateLimitsPtrOutput

func (QueueRateLimitsPtrOutput) ToQueueRateLimitsPtrOutputWithContext 

func (o QueueRateLimitsPtrOutput) ToQueueRateLimitsPtrOutputWithContext(ctx context.Context) QueueRateLimitsPtrOutput

type QueueRetryConfig 

type QueueRetryConfig struct {
	// 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.
	MaxAttempts *int `pulumi:"maxAttempts"`
	// 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.
	MaxBackoff *string `pulumi:"maxBackoff"`
	// 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.
	MaxDoublings *int `pulumi:"maxDoublings"`
	// 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.
	MaxRetryDuration *string `pulumi:"maxRetryDuration"`
	// 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.
	MinBackoff *string `pulumi:"minBackoff"`
}

type QueueRetryConfigArgs 

type QueueRetryConfigArgs struct {
	// 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.
	MaxAttempts pulumi.IntPtrInput `pulumi:"maxAttempts"`
	// 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.
	MaxBackoff pulumi.StringPtrInput `pulumi:"maxBackoff"`
	// 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.
	MaxDoublings pulumi.IntPtrInput `pulumi:"maxDoublings"`
	// 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.
	MaxRetryDuration pulumi.StringPtrInput `pulumi:"maxRetryDuration"`
	// 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.
	MinBackoff pulumi.StringPtrInput `pulumi:"minBackoff"`
}

func (QueueRetryConfigArgs) ElementType 

func (QueueRetryConfigArgs) ElementType() reflect.Type

func (QueueRetryConfigArgs) ToQueueRetryConfigOutput 

func (i QueueRetryConfigArgs) ToQueueRetryConfigOutput() QueueRetryConfigOutput

func (QueueRetryConfigArgs) ToQueueRetryConfigOutputWithContext 

func (i QueueRetryConfigArgs) ToQueueRetryConfigOutputWithContext(ctx context.Context) QueueRetryConfigOutput

func (QueueRetryConfigArgs) ToQueueRetryConfigPtrOutput 

func (i QueueRetryConfigArgs) ToQueueRetryConfigPtrOutput() QueueRetryConfigPtrOutput

func (QueueRetryConfigArgs) ToQueueRetryConfigPtrOutputWithContext 

func (i QueueRetryConfigArgs) ToQueueRetryConfigPtrOutputWithContext(ctx context.Context) QueueRetryConfigPtrOutput

type QueueRetryConfigInput 

type QueueRetryConfigInput interface {
	pulumi.Input

	ToQueueRetryConfigOutput() QueueRetryConfigOutput
	ToQueueRetryConfigOutputWithContext(context.Context) QueueRetryConfigOutput
}

QueueRetryConfigInput is an input type that accepts QueueRetryConfigArgs and QueueRetryConfigOutput values. You can construct a concrete instance of `QueueRetryConfigInput` via: 

QueueRetryConfigArgs{...}

type QueueRetryConfigOutput 

type QueueRetryConfigOutput struct{ *pulumi.OutputState }

func (QueueRetryConfigOutput) ElementType 

func (QueueRetryConfigOutput) ElementType() reflect.Type

func (QueueRetryConfigOutput) MaxAttempts 

func (o QueueRetryConfigOutput) MaxAttempts() pulumi.IntPtrOutput

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.

func (QueueRetryConfigOutput) MaxBackoff 

func (o QueueRetryConfigOutput) MaxBackoff() pulumi.StringPtrOutput

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.

func (QueueRetryConfigOutput) MaxDoublings 

func (o QueueRetryConfigOutput) MaxDoublings() pulumi.IntPtrOutput

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.

func (QueueRetryConfigOutput) MaxRetryDuration 

func (o QueueRetryConfigOutput) MaxRetryDuration() pulumi.StringPtrOutput

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.

func (QueueRetryConfigOutput) MinBackoff 

func (o QueueRetryConfigOutput) MinBackoff() pulumi.StringPtrOutput

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.

func (QueueRetryConfigOutput) ToQueueRetryConfigOutput 

func (o QueueRetryConfigOutput) ToQueueRetryConfigOutput() QueueRetryConfigOutput

func (QueueRetryConfigOutput) ToQueueRetryConfigOutputWithContext 

func (o QueueRetryConfigOutput) ToQueueRetryConfigOutputWithContext(ctx context.Context) QueueRetryConfigOutput

func (QueueRetryConfigOutput) ToQueueRetryConfigPtrOutput 

func (o QueueRetryConfigOutput) ToQueueRetryConfigPtrOutput() QueueRetryConfigPtrOutput

func (QueueRetryConfigOutput) ToQueueRetryConfigPtrOutputWithContext 

func (o QueueRetryConfigOutput) ToQueueRetryConfigPtrOutputWithContext(ctx context.Context) QueueRetryConfigPtrOutput

type QueueRetryConfigPtrInput 

type QueueRetryConfigPtrInput interface {
	pulumi.Input

	ToQueueRetryConfigPtrOutput() QueueRetryConfigPtrOutput
	ToQueueRetryConfigPtrOutputWithContext(context.Context) QueueRetryConfigPtrOutput
}

QueueRetryConfigPtrInput is an input type that accepts QueueRetryConfigArgs, QueueRetryConfigPtr and QueueRetryConfigPtrOutput values. You can construct a concrete instance of `QueueRetryConfigPtrInput` via: 

        QueueRetryConfigArgs{...}

or:

        nil

func QueueRetryConfigPtr 

func QueueRetryConfigPtr(v *QueueRetryConfigArgs) QueueRetryConfigPtrInput

type QueueRetryConfigPtrOutput 

type QueueRetryConfigPtrOutput struct{ *pulumi.OutputState }

func (QueueRetryConfigPtrOutput) Elem 

func (o QueueRetryConfigPtrOutput) Elem() QueueRetryConfigOutput

func (QueueRetryConfigPtrOutput) ElementType 

func (QueueRetryConfigPtrOutput) ElementType() reflect.Type

func (QueueRetryConfigPtrOutput) MaxAttempts 

func (o QueueRetryConfigPtrOutput) MaxAttempts() pulumi.IntPtrOutput

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.

func (QueueRetryConfigPtrOutput) MaxBackoff 

func (o QueueRetryConfigPtrOutput) MaxBackoff() pulumi.StringPtrOutput

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.

func (QueueRetryConfigPtrOutput) MaxDoublings 

func (o QueueRetryConfigPtrOutput) MaxDoublings() pulumi.IntPtrOutput

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.

func (QueueRetryConfigPtrOutput) MaxRetryDuration 

func (o QueueRetryConfigPtrOutput) MaxRetryDuration() pulumi.StringPtrOutput

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.

func (QueueRetryConfigPtrOutput) MinBackoff 

func (o QueueRetryConfigPtrOutput) MinBackoff() pulumi.StringPtrOutput

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.

func (QueueRetryConfigPtrOutput) ToQueueRetryConfigPtrOutput 

func (o QueueRetryConfigPtrOutput) ToQueueRetryConfigPtrOutput() QueueRetryConfigPtrOutput

func (QueueRetryConfigPtrOutput) ToQueueRetryConfigPtrOutputWithContext 

func (o QueueRetryConfigPtrOutput) ToQueueRetryConfigPtrOutputWithContext(ctx context.Context) QueueRetryConfigPtrOutput

type QueueStackdriverLoggingConfig 

type QueueStackdriverLoggingConfig struct {
	// Specifies the fraction of operations to write to Stackdriver Logging.
	// This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the
	// default and means that no operations are logged.
	SamplingRatio float64 `pulumi:"samplingRatio"`
}

type QueueStackdriverLoggingConfigArgs 

type QueueStackdriverLoggingConfigArgs struct {
	// Specifies the fraction of operations to write to Stackdriver Logging.
	// This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the
	// default and means that no operations are logged.
	SamplingRatio pulumi.Float64Input `pulumi:"samplingRatio"`
}

func (QueueStackdriverLoggingConfigArgs) ElementType 

func (QueueStackdriverLoggingConfigArgs) ElementType() reflect.Type

func (QueueStackdriverLoggingConfigArgs) ToQueueStackdriverLoggingConfigOutput 

func (i QueueStackdriverLoggingConfigArgs) ToQueueStackdriverLoggingConfigOutput() QueueStackdriverLoggingConfigOutput

func (QueueStackdriverLoggingConfigArgs) ToQueueStackdriverLoggingConfigOutputWithContext 

func (i QueueStackdriverLoggingConfigArgs) ToQueueStackdriverLoggingConfigOutputWithContext(ctx context.Context) QueueStackdriverLoggingConfigOutput

func (QueueStackdriverLoggingConfigArgs) ToQueueStackdriverLoggingConfigPtrOutput 

func (i QueueStackdriverLoggingConfigArgs) ToQueueStackdriverLoggingConfigPtrOutput() QueueStackdriverLoggingConfigPtrOutput

func (QueueStackdriverLoggingConfigArgs) ToQueueStackdriverLoggingConfigPtrOutputWithContext 

func (i QueueStackdriverLoggingConfigArgs) ToQueueStackdriverLoggingConfigPtrOutputWithContext(ctx context.Context) QueueStackdriverLoggingConfigPtrOutput

type QueueStackdriverLoggingConfigInput 

type QueueStackdriverLoggingConfigInput interface {
	pulumi.Input

	ToQueueStackdriverLoggingConfigOutput() QueueStackdriverLoggingConfigOutput
	ToQueueStackdriverLoggingConfigOutputWithContext(context.Context) QueueStackdriverLoggingConfigOutput
}

QueueStackdriverLoggingConfigInput is an input type that accepts QueueStackdriverLoggingConfigArgs and QueueStackdriverLoggingConfigOutput values. You can construct a concrete instance of `QueueStackdriverLoggingConfigInput` via: 

QueueStackdriverLoggingConfigArgs{...}

type QueueStackdriverLoggingConfigOutput 

type QueueStackdriverLoggingConfigOutput struct{ *pulumi.OutputState }

func (QueueStackdriverLoggingConfigOutput) ElementType 

func (QueueStackdriverLoggingConfigOutput) ElementType() reflect.Type

func (QueueStackdriverLoggingConfigOutput) SamplingRatio 

func (o QueueStackdriverLoggingConfigOutput) SamplingRatio() pulumi.Float64Output

Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.

func (QueueStackdriverLoggingConfigOutput) ToQueueStackdriverLoggingConfigOutput 

func (o QueueStackdriverLoggingConfigOutput) ToQueueStackdriverLoggingConfigOutput() QueueStackdriverLoggingConfigOutput

func (QueueStackdriverLoggingConfigOutput) ToQueueStackdriverLoggingConfigOutputWithContext 

func (o QueueStackdriverLoggingConfigOutput) ToQueueStackdriverLoggingConfigOutputWithContext(ctx context.Context) QueueStackdriverLoggingConfigOutput

func (QueueStackdriverLoggingConfigOutput) ToQueueStackdriverLoggingConfigPtrOutput 

func (o QueueStackdriverLoggingConfigOutput) ToQueueStackdriverLoggingConfigPtrOutput() QueueStackdriverLoggingConfigPtrOutput

func (QueueStackdriverLoggingConfigOutput) ToQueueStackdriverLoggingConfigPtrOutputWithContext 

func (o QueueStackdriverLoggingConfigOutput) ToQueueStackdriverLoggingConfigPtrOutputWithContext(ctx context.Context) QueueStackdriverLoggingConfigPtrOutput

type QueueStackdriverLoggingConfigPtrInput 

type QueueStackdriverLoggingConfigPtrInput interface {
	pulumi.Input

	ToQueueStackdriverLoggingConfigPtrOutput() QueueStackdriverLoggingConfigPtrOutput
	ToQueueStackdriverLoggingConfigPtrOutputWithContext(context.Context) QueueStackdriverLoggingConfigPtrOutput
}

QueueStackdriverLoggingConfigPtrInput is an input type that accepts QueueStackdriverLoggingConfigArgs, QueueStackdriverLoggingConfigPtr and QueueStackdriverLoggingConfigPtrOutput values. You can construct a concrete instance of `QueueStackdriverLoggingConfigPtrInput` via: 

        QueueStackdriverLoggingConfigArgs{...}

or:

        nil

func QueueStackdriverLoggingConfigPtr 

func QueueStackdriverLoggingConfigPtr(v *QueueStackdriverLoggingConfigArgs) QueueStackdriverLoggingConfigPtrInput

type QueueStackdriverLoggingConfigPtrOutput 

type QueueStackdriverLoggingConfigPtrOutput struct{ *pulumi.OutputState }

func (QueueStackdriverLoggingConfigPtrOutput) Elem 

func (o QueueStackdriverLoggingConfigPtrOutput) Elem() QueueStackdriverLoggingConfigOutput

func (QueueStackdriverLoggingConfigPtrOutput) ElementType 

func (QueueStackdriverLoggingConfigPtrOutput) ElementType() reflect.Type

func (QueueStackdriverLoggingConfigPtrOutput) SamplingRatio 

func (o QueueStackdriverLoggingConfigPtrOutput) SamplingRatio() pulumi.Float64PtrOutput

Specifies the fraction of operations to write to Stackdriver Logging. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.

func (QueueStackdriverLoggingConfigPtrOutput) ToQueueStackdriverLoggingConfigPtrOutput 

func (o QueueStackdriverLoggingConfigPtrOutput) ToQueueStackdriverLoggingConfigPtrOutput() QueueStackdriverLoggingConfigPtrOutput

func (QueueStackdriverLoggingConfigPtrOutput) ToQueueStackdriverLoggingConfigPtrOutputWithContext 

func (o QueueStackdriverLoggingConfigPtrOutput) ToQueueStackdriverLoggingConfigPtrOutputWithContext(ctx context.Context) QueueStackdriverLoggingConfigPtrOutput

type QueueState 

type QueueState struct {
	// Overrides for task-level appEngineRouting. These settings apply only
	// to App Engine tasks in this queue
	// Structure is documented below.
	AppEngineRoutingOverride QueueAppEngineRoutingOverridePtrInput
	// The location of the queue
	Location pulumi.StringPtrInput
	// The queue name.
	Name pulumi.StringPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// 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.
	RateLimits QueueRateLimitsPtrInput
	// Settings that determine the retry behavior.
	// Structure is documented below.
	RetryConfig QueueRetryConfigPtrInput
	// Configuration options for writing logs to Stackdriver Logging.
	// Structure is documented below.
	StackdriverLoggingConfig QueueStackdriverLoggingConfigPtrInput
}

func (QueueState) ElementType 

func (QueueState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.