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

注意

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

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

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

要在 playbook 中使用它，请指定：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

字符串

应用实例。

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

service

字符串

应用服务。

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

version

字符串

应用版本。

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

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 和 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 任务。

已返回: 成功

主机

字符串

任务被发送到的主机。

已返回: 成功

instance

字符串

应用实例。

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

已返回: 成功

service

字符串

应用服务。

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

已返回: 成功

version

字符串

应用版本。

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

已返回: 成功

location

字符串

队列的位置。

已返回: 成功

name

字符串

队列名称。

已返回: 成功

速率限制

复杂类型

任务调度的速率限制。

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

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

已返回: 成功

maxBurstSize

整数

最大突发大小。

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

已返回: 成功

maxConcurrentDispatches

整数

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

已返回: 成功

maxDispatchesPerSecond

字符串

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

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

已返回: 成功

retryConfig

复杂类型

确定重试行为的设置。

已返回: 成功

maxAttempts

整数

每个任务的尝试次数。

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

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

-1 表示无限次尝试。

已返回: 成功

maxBackoff

字符串

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

已返回: 成功

maxDoublings

整数

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

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

已返回: 成功

maxRetryDuration

字符串

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

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

已返回: 成功

minBackoff

字符串

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

已返回: 成功

purgeTime

字符串

上次清除此队列的时间。

已返回: 成功

stackdriverLoggingConfig

复杂类型

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

已返回: 成功

samplingRatio

字符串

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

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

已返回: 成功

status

字符串

队列的当前状态。

已返回: 成功

作者

  • Google Inc. (@googlecloudplatform)