gcp_pubsub_subscription_info – Сбор информации о подписке GCP

Новая версия с 2.8.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Сбор информации о подписке GCP
Этот модуль назывался gcp_pubsub_subscription_facts до Ansible 2.9. Использование не изменилось.

Псевдонимы: gcp_pubsub_subscription_facts

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_kind строка / обязательно	Варианты: application machineaccount serviceaccount	Тип используемых учетных данных.
env_type строка		Указывает, в какой среде Ansible вы выполняете этот модуль. Это следует устанавливать только в случае необходимости. Это изменяет только строку User Agent для любых запросов к API.
project строка		Проект Google Cloud Platform, который следует использовать.
scopes список		Массив используемых областей.
service_account_contents jsonarg		Содержимое файла JSON учетной записи службы, представленное в виде словаря или JSON-строки, представляющей его.
service_account_email строка		Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь		Путь к файлу JSON учетной записи службы, если в качестве типа выбран serviceaccount.

Примечания

Примечание

для аутентификации можно установить service_account_file с помощью переменной среды c(gcp_service_account_file).
для аутентификации можно установить service_account_contents с помощью переменной среды c(GCP_SERVICE_ACCOUNT_CONTENTS).
для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
значения переменных среды будут использоваться только в том случае, если значения в playbook не заданы.
параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: get info on a subscription
  gcp_pubsub_subscription_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ			Возвращаемое значение	Описание
resources сложный			всегда	Список ресурсов
	ackDeadlineSeconds целое число		успех	Это значение представляет максимальное время после того, как подписчик получает сообщение, прежде чем подписчик должен подтвердить сообщение. После доставки сообщения, но до истечения срока подтверждения и до подтверждения сообщения, это незавершенное сообщение и оно не будет повторно доставлено в течение этого времени (на основе наилучших усилий). Для подписок pull это значение используется в качестве начального значения для срока подтверждения. Для переопределения этого значения для конкретного сообщения вызовите subscriptions.modifyAckDeadline со соответствующим ackId, если используется pull. Минимальный настраиваемый срок, который можно указать, составляет 10 секунд. Максимальный настраиваемый срок, который можно указать, составляет 600 секунд (10 минут). Если этот параметр равен 0, используется значение по умолчанию 10 секунд. Для доставки push это значение также используется для установки таймаута запроса для вызова push-пункта. Если подписчик никогда не подтвердит сообщение, система Pub/Sub в конечном итоге повторно доставит сообщение.
	expirationPolicy сложный		успех	Политика, которая определяет условия для истечения срока действия этой подписки. Подписка считается активной, пока любой подключенный подписчик успешно потребляет сообщения из подписки или выполняет операции с подпиской. Если expirationPolicy не задан, будет использоваться политика по умолчанию с ttl 31 день. Минимальное разрешенное значение для expirationPolicy.ttl составляет 1 день.
		ttl строка	успех	Указывает продолжительность "времени жизни" для связанного ресурса. Ресурс истекает, если он неактивен в течение периода ttl. Определение "активности" зависит от типа связанного ресурса. Минимальные и максимальные разрешенные значения для ttl также зависят от типа связанного ресурса. Если ttl не задан, связанный ресурс никогда не истекает. Продолжительность в секундах с точностью до девяти дробных знаков, завершенная символом 's'. Пример - "3.5s".
	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-адрес конечной точки, в которую должны отправляться сообщения. Например, конечная точка Webhook может использовать "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.9/modules/gcp_pubsub_subscription_info_module.html