Try SpotterCreates a GCP Queue
Authors: Google Inc. (@googlecloudplatform)
preview | supported by community
Install with ansible-galaxy collection install delowan.googlecloud:==1.0.2
collections:
- name: delowan.googlecloud
version: 1.0.2A named resource to which messages are sent by publishers.
- 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
name:
description:
- The queue name.
required: false
type: str
state:
choices:
- present
- absent
default: present
description:
- Whether the given object should exist in GCP
type: str
scopes:
description:
- Array of scopes to be used
elements: str
type: list
status:
description:
- The current state of the queue.
- 'Some valid choices include: "RUNNING", "PAUSED", "DISABLED"'
required: false
type: str
project:
description:
- The Google Cloud Platform project to use.
type: str
env_type:
description:
- 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.
type: str
location:
description:
- The location of the queue.
required: true
type: str
auth_kind:
choices:
- application
- machineaccount
- serviceaccount
description:
- The type of credential used.
required: true
type: str
rate_limits:
description:
- 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.'
required: false
suboptions:
max_concurrent_dispatches:
description:
- 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.
required: false
type: int
max_dispatches_per_second:
description:
- The maximum rate at which tasks are dispatched from this queue.
- If unspecified when the queue is created, Cloud Tasks will pick the default.
required: false
type: str
type: dict
retry_config:
description:
- Settings that determine the retry behavior.
required: false
suboptions:
max_attempts:
description:
- 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.
required: false
type: int
max_backoff:
description:
- 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.
required: false
type: str
max_doublings:
description:
- 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.
required: false
type: int
max_retry_duration:
description:
- 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.
required: false
type: str
min_backoff:
description:
- 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.
required: false
type: str
type: dict
service_account_file:
description:
- The path of a Service Account JSON file if serviceaccount is selected as type.
type: path
service_account_email:
description:
- An optional service account email address if machineaccount is selected and the
user does not wish to use the default email.
type: str
service_account_contents:
description:
- The contents of a Service Account JSON file, either in a dictionary or as a JSON
string that represents it.
type: jsonarg
stackdriver_logging_config:
description:
- Configuration options for writing logs to Stackdriver Logging.
required: false
suboptions:
sampling_ratio:
description:
- 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.
required: true
type: str
type: dict
app_engine_routing_override:
description:
- Overrides for task-level appEngineRouting. These settings apply only to App Engine
tasks in this queue .
required: false
suboptions:
instance:
description:
- App instance.
- By default, the task is sent to an instance which is available when the task
is attempted.
required: false
type: str
service:
description:
- App service.
- By default, the task is sent to the service which is the default service when
the task is attempted.
required: false
type: str
version:
description:
- App version.
- By default, the task is sent to the version which is the default version when
the task is attempted.
required: false
type: str
type: dict
appEngineRoutingOverride:
contains:
host:
description:
- The host that the task is sent to.
returned: success
type: str
instance:
description:
- App instance.
- By default, the task is sent to an instance which is available when the task
is attempted.
returned: success
type: str
service:
description:
- App service.
- By default, the task is sent to the service which is the default service when
the task is attempted.
returned: success
type: str
version:
description:
- App version.
- By default, the task is sent to the version which is the default version when
the task is attempted.
returned: success
type: str
description:
- Overrides for task-level appEngineRouting. These settings apply only to App Engine
tasks in this queue .
returned: success
type: complex
location:
description:
- The location of the queue.
returned: success
type: str
name:
description:
- The queue name.
returned: success
type: str
rateLimits:
contains:
maxBurstSize:
description:
- 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
type: int
maxConcurrentDispatches:
description:
- 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
type: int
maxDispatchesPerSecond:
description:
- 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
type: str
description:
- 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.'
returned: success
type: complex
retryConfig:
contains:
maxAttempts:
description:
- 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
type: int
maxBackoff:
description:
- 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
type: str
maxDoublings:
description:
- 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
type: int
maxRetryDuration:
description:
- 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
type: str
minBackoff:
description:
- 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
type: str
purgeTime:
description:
- The last time this queue was purged.
returned: success
type: str
description:
- Settings that determine the retry behavior.
returned: success
type: complex
stackdriverLoggingConfig:
contains:
samplingRatio:
description:
- 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
type: str
description:
- Configuration options for writing logs to Stackdriver Logging.
returned: success
type: complex
status:
description:
- The current state of the queue.
returned: success
type: str