Модуль google.cloud.gcp_pubsub_subscription_info — сбор информации о подписке GCP

access_token

string

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

string / обязательный

Тип используемых учетных данных.

Варианты:

• "application"
• "machineaccount"
• "serviceaccount"
• "accesstoken"

env_type

string

Указывает, в какой среде Ansible выполняется этот модуль.

Не задавайте этот параметр, если не знаете, что делаете.

Он изменяет только строку User Agent для любых запросов к API.

project

string

Проект Google Cloud Platform, который следует использовать.

scopes

list / элементы=string

Массив используемых областей действия

service_account_contents

jsonarg

Содержимое JSON-файла учетной записи службы в виде словаря или JSON-строки, представляющей этот файл.

service_account_email

string

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

service_account_file

path

Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.

resources

complex

Список ресурсов

Возвращается: всегда

ackDeadlineSeconds

integer

Это значение задает максимальное время после получения сообщения подписчиком, в течение которого подписчик должен подтвердить получение сообщения. После доставки сообщения, но до истечения срока подтверждения и подтверждения сообщения оно считается необработанным и в течение этого времени повторно не доставляется (по мере возможности).

Для pull-подписок это значение используется как начальный срок подтверждения. Чтобы изменить его для конкретного сообщения, вызовите subscriptions.modifyAckDeadline с соответствующим ackId при использовании pull. Минимальный задаваемый вручную срок — 10 секунд. Максимальный задаваемый вручную срок — 600 секунд (10 минут).

Если значение этого параметра равно 0, используется значение по умолчанию — 10 секунд.

При push-доставке это значение также используется для установки времени ожидания запроса к конечной точке push.

Если подписчик так и не подтвердит получение сообщения, система Pub/Sub в конечном итоге доставит его повторно.

Возвращается: при успехе

deadLetterPolicy

complex

Политика, задающая условия перенаправления сообщений в очередь недоставленных сообщений для этой подписки. Если dead_letter_policy не задана, перенаправление в очередь недоставленных сообщений отключено.

Учетная запись службы Cloud Pub/Sub, связанная с родительским проектом этой подписки (т. е. service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com), должна иметь разрешение Acknowledge() для сообщений этой подписки.

Возвращается: при успехе

deadLetterTopic

string

Имя темы, в которую следует публиковать сообщения из очереди недоставленных сообщений.

Формат: `projects/{project}/topics/{topic}`.

Учетная запись службы Cloud Pub/Sub, связанная с родительским проектом данной подписки (т. е. service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com), должна иметь разрешение Publish() для этой темы.

Операция завершится ошибкой, если тема не существует.

Пользователям следует убедиться, что к этой теме подключена подписка, поскольку сообщения, опубликованные в теме без подписок, теряются.

Возвращается: при успехе

maxDeliveryAttempts

integer

Максимальное количество попыток доставки любого сообщения. Значение должно находиться в диапазоне от 5 до 100.

Количество попыток доставки определяется как 1 + (сумма числа NACK и числа случаев истечения срока подтверждения для сообщения).

NACK — это любой вызов ModifyAckDeadline со сроком, равным 0. Обратите внимание, что клиентские библиотеки могут автоматически продлевать ack_deadlines.

Это поле учитывается по мере возможности.

Если значение этого параметра равно 0, используется значение по умолчанию — 5.

Возвращается: при успехе

enableMessageOrdering

boolean

Если задано значение `true`, сообщения, опубликованные с одинаковым orderingKey в PubsubMessage, будут доставляться подписчикам в том порядке, в котором их получила система Pub/Sub. В противном случае порядок доставки может быть произвольным.

Возвращается: при успехе

expirationPolicy

complex

Политика, задающая условия истечения срока действия этой подписки.

Подписка считается активной, пока подключенный подписчик успешно получает из нее сообщения или выполняет операции с ней. Если expirationPolicy не задана, используется политика по умолчанию со значением ttl 31 день. Если она задана, но ttl равен “”, ресурс никогда не истекает. Минимальное допустимое значение expirationPolicy.ttl — 1 день.

Возвращается: при успехе

ttl

string

Задает срок жизни связанного ресурса. Ресурс истекает, если он неактивен в течение периода ttl.

Если ttl не задан, связанный ресурс никогда не истекает.

Длительность в секундах с точностью до девяти знаков после запятой, завершающаяся символом ‘s’.

Пример — “3.5s”.

Возвращается: при успехе

filter

string

Подписка доставляет только сообщения, соответствующие фильтру. Pub/Sub автоматически подтверждает сообщения, не соответствующие фильтру. Фильтровать сообщения можно по их атрибутам. Максимальная длина фильтра — 256 байт. После создания подписки изменить фильтр нельзя.

Возвращается: при успехе

labels

dictionary

Набор пар ключ/значение меток, назначаемых этой подписке.

Возвращается: при успехе

messageRetentionDuration

string

Как долго хранить неподтвержденные сообщения в очереди подписки, начиная с момента публикации сообщения. Если retainAckedMessages равно true, этот параметр также задает срок хранения подтвержденных сообщений и, следовательно, определяет, насколько далеко в прошлое можно выполнить subscriptions.seek. По умолчанию — 7 дней. Значение не может превышать 7 дней (`”604800s”`) или быть меньше 10 минут (`”600s”`).

Длительность в секундах с точностью до девяти знаков после запятой, завершающаяся символом ‘s’. Пример: `”600.5s”`.

Возвращается: при успехе

name

string

Имя подписки.

Возвращается: при успехе

pushConfig

complex

Если для этой подписки используется push-доставка, это поле задает ее конфигурацию. Пустое значение pushConfig означает, что подписчик будет получать и подтверждать сообщения с помощью методов API.

Возвращается: при успехе

attributes

dictionary

Атрибуты конфигурации конечной точки.

Для каждой конечной точки предусмотрен набор поддерживаемых 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.

Возвращается: при успехе

oidcToken

complex

Если этот параметр задан, Pub/Sub будет формировать токен OIDC JWT и добавлять его в качестве заголовка Authorization к HTTP-запросу для каждого отправляемого сообщения.

Возвращается: при успехе

audience

string

Аудитория, используемая при создании токена OIDC. Утверждение audience идентифицирует получателей, для которых предназначен JWT. Значение audience представляет собой одну строку с учетом регистра. Указание нескольких значений (массива) для поля audience не поддерживается. Подробнее об аудитории токена OIDC JWT: https://tools.ietf.org/html/rfc7519#section-4.1.3 Примечание: если значение не указано, используется URL конечной точки push.

Возвращается: при успехе

serviceAccountEmail

string

Адрес электронной почты учетной записи службы, используемой для создания токена OIDC.

Вызывающая сторона (для RPC subscriptions.create, subscriptions.patch и subscriptions.modifyPushConfig) должна иметь разрешение iam.serviceAccounts.actAs для этой учетной записи службы.

Возвращается: при успехе

pushEndpoint

string

URL конечной точки, на которую следует отправлять сообщения.

Например, конечная точка Webhook может использовать «https://example.com/push”.

Возвращается: при успехе

retainAckedMessages

boolean

Указывает, следует ли сохранять подтвержденные сообщения. Если задано значение `true`, сообщения не удаляются из очереди подписки даже после подтверждения, пока не истечет период messageRetentionDuration.

Возвращается: при успехе

retryPolicy

complex

Политика, задающая порядок повторной доставки сообщений Pub/Sub для этой подписки.

Если политика не задана, применяется политика повторных попыток по умолчанию. Как правило, это означает, что сообщения будут повторно доставляться как можно скорее при исправной работе подписчиков. RetryPolicy активируется при получении NACK или истечении срока подтверждения для определенного сообщения.

Возвращается: при успехе

maximumBackoff

string

Максимальная задержка между последовательными попытками доставки одного сообщения. Значение должно находиться в диапазоне от 0 до 600 секунд. По умолчанию — 600 секунд. Длительность в секундах с точностью до девяти знаков после запятой, завершающаяся символом ‘s’. Пример: “3.5s”.

Возвращается: при успехе

minimumBackoff

string

Минимальная задержка между последовательными попытками доставки одного сообщения. Значение должно находиться в диапазоне от 0 до 600 секунд. По умолчанию — 10 секунд.

Длительность в секундах с точностью до девяти знаков после запятой, завершающаяся символом ‘s’. Пример: “3.5s”.

Возвращается: при успехе

topic

dictionary

Ссылка на ресурс Topic.

Возвращается: при успехе