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

resources

сложный

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

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

ackDeadlineSeconds

целое число

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

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

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

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

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

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

deadLetterPolicy

сложный

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

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

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

deadLetterTopic

строка

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

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

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

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

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

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

maxDeliveryAttempts

целое число

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

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

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

Этот параметр будет выполняться на основе наилучших усилий.

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

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

enableMessageOrdering

логический

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

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

expirationPolicy

сложный

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

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

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

ttl

строка

Указывает продолжительность «срока действия» для связанного ресурса. Ресурс истекает, если он неактивен в течение периода ttl.

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

Продолжительность в секундах с до девятью знаками после запятой, завершающимися символом «s».

Пример — «3.5s».

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

filter

строка

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

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

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: использует формат отправки, определённый в API Pub/Sub v1beta1.

• v1 или v1beta2: использует формат отправки, определённый в API Pub/Sub v1.

Возвращается: успешно

oidcToken

сложный

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

Возвращается: успешно

audience

строка

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

Возвращается: успешно

serviceAccountEmail

строка

Электронная почта учетной записи службы, которая будет использоваться для генерации токена OIDC.

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

Возвращается: успешно

pushEndpoint

строка

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

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

Возвращается: успешно

retainAckedMessages

булево

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

Возвращается: успешно

retryPolicy

сложный

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

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

Возвращается: успешно

maximumBackoff

строка

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

Возвращается: успешно

minimumBackoff

строка

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

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

Возвращается: успешно

topic

словарь

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

Возвращается: успешно