google.cloud.gcp_cloudtasks_queue 模块 – 创建 GCP 队列

注意

此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定：google.cloud.gcp_cloudtasks_queue。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中删除。该集合存在 未解决的完整性测试失败。有关更多信息，请参阅 讨论主题。

概要

  • 发布者向其发送消息的命名资源。

要求

执行此模块的主机需要以下要求。

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

app_engine_routing_override

字典

针对任务级 appEngineRouting 的覆盖。这些设置仅适用于此队列中的 App Engine 任务。

instance

字符串

App 实例。

默认情况下，任务将发送到尝试任务时可用的实例。

service

字符串

App 服务。

默认情况下，任务将发送到尝试任务时为默认服务的服务。

version

字符串

App 版本。

默认情况下，任务将发送到尝试任务时为默认版本的版本。

auth_kind

字符串 / 必需

使用的凭据类型。

选项

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

字符串

指定您在哪个 Ansible 环境中运行此模块。

除非您知道自己在做什么，否则不应设置此选项。

这只会更改任何 API 请求的用户代理字符串。

location

字符串 / 必需

队列的位置。

name

字符串

队列名称。

project

字符串

要使用的 Google Cloud Platform 项目。

rate_limits

字典

任务调度的速率限制。

队列的实际调度速率是以下结果：* 队列中任务的数量 * 用户指定的限制：rateLimits、retryConfig 和队列的状态。*

* 来自工作程序的 429（请求过多）或 503（服务不可用）响应、高错误率或平滑突然的大流量峰值导致的系统限制。

max_concurrent_dispatches

整数

Cloud Tasks 允许为此队列调度并发任务的最大数量。达到此阈值后，Cloud Tasks 将停止调度任务，直到并发请求数量减少。

max_dispatches_per_second

字符串

从此队列调度任务的最大速率。

如果创建队列时未指定，Cloud Tasks 将选择默认值。

retry_config

字典

确定重试行为的设置。

max_attempts

整数

每个任务的尝试次数。

Cloud Tasks 将尝试 maxAttempts 次任务（即，如果第一次尝试失败，则将有 maxAttempts - 1 次重试）。必须 >= -1。

如果创建队列时未指定，Cloud Tasks 将选择默认值。

-1 表示无限次尝试。

max_backoff

字符串

如果队列的 RetryConfig 指定应重试任务，则任务将在失败后在 minBackoff 和 maxBackoff 持续时间之间安排重试。

max_doublings

整数

重试之间的时间将增加 maxDoublings 倍。

任务的重试间隔从 minBackoff 开始，然后增加 maxDoublings 倍，然后线性增加，最后以 maxBackoff 的间隔重试，最多重试 maxAttempts 次。

max_retry_duration

字符串

如果为正数，maxRetryDuration 指定重试失败任务的时间限制，从第一次尝试任务时开始计算。一旦超过 maxRetryDuration 时间并且任务已尝试 maxAttempts 次，将不会进行进一步尝试，并且任务将被删除。

如果为零，则任务年龄不受限制。

min_backoff

字符串

如果队列的 RetryConfig 指定应重试任务，则任务将在失败后在 minBackoff 和 maxBackoff 持续时间之间安排重试。

scopes

列表 / 元素=字符串

要使用的作用域数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。

service_account_email

字符串

如果选择 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。

service_account_file

路径

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

stackdriver_logging_config

字典

将日志写入 Stackdriver Logging 的配置选项。

sampling_ratio

字符串 / 必需

指定写入 Stackdriver Logging 的操作比例。

此字段可以包含 0.0 到 1.0（含）之间的任何值。0.0 为默认值，表示不记录任何操作。

state

字符串

给定对象是否应该存在于 GCP 中

选项

  • "present" ← (默认)

  • "absent"

status

字符串

队列的当前状态。

一些有效的选项包括：“RUNNING”、“PAUSED”、“DISABLED”

示例

- 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

返回值

公共返回值已记录在 此处，以下是此模块特有的字段

键

描述

appEngineRoutingOverride

复杂类型

针对任务级 appEngineRouting 的覆盖。这些设置仅适用于此队列中的 App Engine 任务。

返回：成功

host

字符串

发送任务的主机。

返回：成功

instance

字符串

App 实例。

默认情况下，任务将发送到尝试任务时可用的实例。

返回：成功

service

字符串

App 服务。

默认情况下，任务将发送到尝试任务时为默认服务的服务。

返回：成功

version

字符串

App 版本。

默认情况下，任务将发送到尝试任务时为默认版本的版本。

返回：成功

location

字符串

队列的位置。

返回：成功

name

字符串

队列名称。

返回：成功

rateLimits

复杂类型

任务调度的速率限制。

队列的实际调度速率是以下结果：* 队列中任务的数量 * 用户指定的限制：rateLimits、retryConfig 和队列的状态。*

* 来自工作程序的 429（请求过多）或 503（服务不可用）响应、高错误率或平滑突然的大流量峰值导致的系统限制。

返回：成功

maxBurstSize

整数

最大突发大小。

最大突发大小限制了当队列中有很多任务并且速率很高时队列中任务的处理速度。此字段允许队列具有高速率，以便在任务入队后不久就开始处理，但仍然限制在短时间内入队许多任务时的资源使用情况。

返回：成功

maxConcurrentDispatches

整数

Cloud Tasks 允许为此队列调度并发任务的最大数量。达到此阈值后，Cloud Tasks 将停止调度任务，直到并发请求数量减少。

返回：成功

每秒最大调度次数

字符串

从此队列调度任务的最大速率。

如果创建队列时未指定，Cloud Tasks 将选择默认值。

返回：成功

重试配置

复杂类型

确定重试行为的设置。

返回：成功

最大尝试次数

整数

每个任务的尝试次数。

Cloud Tasks 将尝试 maxAttempts 次任务（即，如果第一次尝试失败，则将有 maxAttempts - 1 次重试）。必须 >= -1。

如果创建队列时未指定，Cloud Tasks 将选择默认值。

-1 表示无限次尝试。

返回：成功

最大回退时间

字符串

如果队列的 RetryConfig 指定应重试任务，则任务将在失败后在 minBackoff 和 maxBackoff 持续时间之间安排重试。

返回：成功

最大倍增次数

整数

重试之间的时间将增加 maxDoublings 倍。

任务的重试间隔从 minBackoff 开始，然后增加 maxDoublings 倍，然后线性增加，最后以 maxBackoff 的间隔重试，最多重试 maxAttempts 次。

返回：成功

最大重试持续时间

字符串

如果为正数，maxRetryDuration 指定重试失败任务的时间限制，从第一次尝试任务时开始计算。一旦超过 maxRetryDuration 时间并且任务已尝试 maxAttempts 次，将不会进行进一步尝试，并且任务将被删除。

如果为零，则任务年龄不受限制。

返回：成功

最小回退时间

字符串

如果队列的 RetryConfig 指定应重试任务，则任务将在失败后在 minBackoff 和 maxBackoff 持续时间之间安排重试。

返回：成功

清除时间

字符串

上次清除此队列的时间。

返回：成功

Stackdriver日志记录配置

复杂类型

将日志写入 Stackdriver Logging 的配置选项。

返回：成功

采样率

字符串

指定写入 Stackdriver Logging 的操作比例。

此字段可以包含 0.0 到 1.0（含）之间的任何值。0.0 为默认值，表示不记录任何操作。

返回：成功

status

字符串

队列的当前状态。

返回：成功

作者

  • 谷歌公司 (@googlecloudplatform)