gcp_pubsub_subscription_facts – Сбор фактов для подписки GCP
Новое в версии 2.8.
Описание
- Сбор фактов для подписки GCP
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
|
auth_kind
строка / обязательно
|
|
Тип используемых учетных данных.
|
|
project
строка
|
Проект Google Cloud Platform для использования.
|
|
|
scopes
список
|
Массив используемых областей.
|
|
|
service_account_contents
строка
|
Строка, представляющая содержимое файла JSON учетной записи службы.
Не нужно передавать это как словарь, а строку с точным содержимым файла service account json (валидный JSON).
|
|
|
service_account_email
строка
|
Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
|
|
|
service_account_file
путь
|
Путь к файлу JSON учетной записи службы, если тип serviceaccount выбран как тип.
|
Примечания
Примечание
- Для проверки подлинности можно установить service_account_file с использованием переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для проверки подлинности можно установить service_account_email с использованием переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для проверки подлинности можно установить service_account_contents с использованием переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для проверки подлинности можно установить auth_kind с использованием переменной среды
GCP_AUTH_KIND. - Для проверки подлинности можно установить scopes с использованием переменной среды
GCP_SCOPES. - Значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
- Параметры service_account_email и service_account_file взаимоисключающие.
Примеры
- name: " a subscription facts"
gcp_pubsub_subscription_facts:
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: facts
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращено | Описание | ||
|---|---|---|---|---|
|
items
сложный
|
всегда |
Список элементов
|
||
|
ackDeadlineSeconds
целое число
|
успех |
Это значение представляет собой максимальное время после того, как подписчик получит сообщение, прежде чем подписчик должен подтвердить сообщение. После доставки сообщения, но до истечения срока подтверждения и до подтверждения сообщения, это незавершенное сообщение и оно не будет повторно доставлено в течение этого времени (по принципу наилучших усилий).
Для подписок pull это значение используется в качестве начального значения для срока подтверждения. Чтобы переопределить это значение для данного сообщения, вызовите subscriptions.modifyAckDeadline с соответствующим ackId, если используете pull. Минимальный настраиваемый срок составляет 10 секунд. Максимальный настраиваемый срок составляет 600 секунд (10 минут).
Если этот параметр равен 0, используется значение по умолчанию 10 секунд.
Для доставки push это значение также используется для установки тайм-аута запроса для вызова конечной точки push.
Если подписчик никогда не подтверждает сообщение, система Pub/Sub в конечном итоге повторно доставит сообщение.
|
||
|
labels
словарь
|
успех |
Набор пар ключ/значение меток, которые нужно назначить этой подписке.
|
||
|
messageRetentionDuration
строка
|
успех |
Сколько времени хранить неопознанные сообщения в очереди подписки с момента публикации сообщения. Если retainAckedMessages равно true, это также настраивает сохранение подтвержденных сообщений и, таким образом, настраивает, как далеко в прошлом можно выполнить subscriptions.seek. По умолчанию 7 дней. Не может быть больше 7 дней («604800s») или меньше 10 минут («600s»).
Длительность в секундах с точностью до девяти десятичных знаков, заканчивающаяся на 's'. Пример: «600.5s».
|
||
|
name
строка
|
успех |
Имя подписки.
|
||
|
pushConfig
сложный
|
успех |
Если для этой подписки используется доставка push, это поле используется для ее настройки. Пустой pushConfig означает, что подписчик будет извлекать и подтверждать сообщения с помощью методов API.
|
||
|
attributes
словарь
|
успех |
Атрибуты конфигурации конечной точки.
У каждой конечной точки есть набор поддерживаемых API атрибутов, которые можно использовать для управления различными аспектами доставки сообщений.
В настоящее время поддерживаемый атрибут — x-goog-version, который можно использовать для изменения формата отправленного сообщения. Этот атрибут указывает ожидаемую версию данных конечной точкой. Это управляет формой отправленного сообщения (т. е. его полями и метаданными). Версия конечной точки основана на версии API Pub/Sub.
Если он отсутствует во время вызова subscriptions.create, он будет установлен по умолчанию на версию API, используемую для такого вызова. Если он отсутствует во время вызова subscriptions.modifyPushConfig, его значение не изменится. Вызовы subscriptions.get всегда будут возвращать допустимую версию, даже если подписка была создана без этого атрибута.
Возможные значения для этого атрибута: - v1beta1: использует формат push, определенный в API Pub/Sub v1beta1.
- v1 или v1beta2: использует формат push, определенный в API Pub/Sub v1.
|
||
|
pushEndpoint
строка
|
успех |
URL, указывающий на конечную точку, в которую должны отправляться сообщения.
Например, конечная точка веб-хука может использовать «https://example.com/push».
|
||
|
retainAckedMessages
булево
|
успех |
Указывает, сохранять ли подтвержденные сообщения. Если значение `true`, сообщения не удаляются из очереди подписки, даже если они подтверждены, до тех пор, пока они не выпадут из окна messageRetentionDuration.
|
||
|
topic
словарь
|
успех |
Ссылка на ресурс Topic.
|
||
Статус
- Интерфейс этого модуля не гарантируется как обратно совместимый. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Google Inc. (@googlecloudplatform)
Подсказка
Если вы заметите какие-либо проблемы в этом руководстве, вы можете редактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/gcp_pubsub_subscription_facts_module.html
