google.cloud.gcp_cloudtasks_queue module – Creates a GCP Queue
Note
This module is part of the google.cloud collection (version 1.0.2).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install google.cloud.
To use it in a playbook, specify: google.cloud.gcp_cloudtasks_queue.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
Parameters
Parameter |
Comments |
|---|---|
Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue . |
|
App instance. By default, the task is sent to an instance which is available when the task is attempted. |
|
App service. By default, the task is sent to the service which is the default service when the task is attempted. |
|
App version. By default, the task is sent to the version which is the default version when the task is attempted. |
|
The type of credential used. Choices:
|
|
Specifies which Ansible environment you’re running this module within. This should not be set unless you know what you’re doing. This only alters the User Agent string for any API requests. |
|
The location of the queue. |
|
The queue name. |
|
The Google Cloud Platform project to use. |
|
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.
|
|
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. |
|
The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. |
|
Settings that determine the retry behavior. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
Array of scopes to be used |
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. |
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email. |
|
The path of a Service Account JSON file if serviceaccount is selected as type. |
|
Configuration options for writing logs to Stackdriver Logging. |
|
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. |
|
Whether the given object should exist in GCP Choices:
|
|
The current state of the queue. Some valid choices include: “RUNNING”, “PAUSED”, “DISABLED” |
Examples
- name: create a queue
google.cloud.gcp_cloudtasks_queue:
name: test_object
location: us-central1
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Overrides for task-level appEngineRouting. These settings apply only to App Engine tasks in this queue . Returned: success |
|
The host that the task is sent to. Returned: success |
|
App instance. By default, the task is sent to an instance which is available when the task is attempted. Returned: success |
|
App service. By default, the task is sent to the service which is the default service when the task is attempted. Returned: success |
|
App version. By default, the task is sent to the version which is the default version when the task is attempted. Returned: success |
|
The location of the queue. Returned: success |
|
The queue name. Returned: success |
|
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.
Returned: success |
|
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. Returned: success |
|
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. Returned: success |
|
The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. Returned: success |
|
Settings that determine the retry behavior. Returned: success |
|
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. Returned: success |
|
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. Returned: success |
|
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. Returned: success |
|
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. Returned: success |
|
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. Returned: success |
|
The last time this queue was purged. Returned: success |
|
Configuration options for writing logs to Stackdriver Logging. Returned: success |
|
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. Returned: success |
|
The current state of the queue. Returned: success |
Authors
Google Inc. (@googlecloudplatform)