Модуль google.cloud.gcp_cloudscheduler_job_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, который следует использовать.

region

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

Регион, в котором находится задание планировщика.

scopes

list / elements=string

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

service_account_contents

jsonarg

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

service_account_email

string

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

service_account_file

path

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

resources

complex

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

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

appEngineHttpTarget

complex

Цель HTTP для App Engine.

Если в задании указана цель HTTP для App Engine, cron отправит запрос экземпляру службы.

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

appEngineRouting

complex

Настройка маршрутизации App Engine для задания.

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

instance

string

Экземпляр приложения.

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

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

service

string

Служба приложения.

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

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

version

string

Версия приложения.

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

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

body

string

Тело HTTP-запроса. Тело запроса допускается только при использовании метода HTTP POST или PUT. Если задать тело для задания с несовместимым значением HttpMethod, возникнет ошибка недопустимого аргумента.

Строка в кодировке base64.

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

headers

dictionary

Заголовки HTTP-запроса.

Эта карта содержит имена и значения полей заголовков. Заголовки можно задать при создании задания.

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

httpMethod

string

Метод HTTP, используемый для запроса.

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

relativeUri

string

Относительный URI.

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

attemptDeadline

string

Крайний срок выполнения попытки задания. Если обработчик запроса не ответит до этого срока, запрос будет отменён, а попытка отмечена как неудачная с ошибкой DEADLINE_EXCEEDED. Неудачную попытку можно просмотреть в журналах выполнения. Cloud Scheduler повторит задание в соответствии с RetryConfig.

Допустимая продолжительность этого срока: * для целей HTTP — от 15 секунд до 30 минут.

* Для целей HTTP App Engine — от 15 секунд до 24 часов.

* **Примечание**: для целей PubSub это поле игнорируется — его настройка приведёт к неустранимому расхождению.

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

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

description

string

Понятное человеку описание задания. Эта строка не должна содержать более 500 символов.

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

httpTarget

complex

Цель HTTP.

Если в задании указана цель http_target, cron отправит запрос на целевой URL.

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

body

string

Тело HTTP-запроса. Тело запроса допускается только при использовании метода HTTP POST, PUT или PATCH. Если задать тело для задания с несовместимым значением HttpMethod, возникнет ошибка.

Строка в кодировке base64.

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

headers

dictionary

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

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

httpMethod

string

Метод HTTP, используемый для запроса.

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

oauthToken

complex

Содержит информацию, необходимую для создания токена OAuth.

Этот тип авторизации следует использовать при отправке запросов к конечной точке GCP.

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

scope

string

Область действия OAuth для создания токена доступа OAuth. Если не указана, будет использоваться «https://www.googleapis.com/auth/cloud-platform».

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

serviceAccountEmail

string

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

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

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

oidcToken

complex

Содержит информацию, необходимую для создания токена OpenID Connect.

Этот тип авторизации следует использовать при отправке запросов к сторонним конечным точкам или Cloud Run.

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

audience

string

Аудитория, используемая при создании токена OIDC. Если не указана, будет использоваться URI, заданный в target.

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

serviceAccountEmail

string

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

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

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

uri

string

Полный путь URI, на который будет отправлен запрос.

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

name

string

Имя задания.

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

pubsubTarget

complex

Цель Pub/Sub. Если в задании указана цель Pub/Sub, cron опубликует сообщение в указанной теме.

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

attributes

dictionary

Атрибуты PubsubMessage.

Сообщение Pubsub должно содержать либо непустые данные, либо хотя бы один атрибут.

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

data

string

Полезная нагрузка сообщения PubsubMessage.

Сообщение Pubsub должно содержать либо непустые данные, либо хотя бы один атрибут.

Строка в кодировке base64.

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

topicName

string

Полное имя ресурса темы Cloud Pub/Sub, в которую будут публиковаться сообщения при выполнении задания. ~>**ПРИМЕЧАНИЕ:** Имя темы должно иметь тот же формат, что и PubSub’s PublishRequest.name, например `projects/my-project/topics/my-topic`.

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

region

string

Регион, в котором находится задание планировщика.

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

retryConfig

complex

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

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

maxBackoffDuration

string

Максимальное время ожидания перед повторной попыткой выполнить задание после сбоя.

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

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

maxDoublings

integer

Интервал между повторными попытками будет удваиваться maxDoublings раз.

Интервал повторных попыток задания начинается с minBackoffDuration, затем удваивается maxDoublings раз, после чего увеличивается линейно; наконец, повторы выполняются с интервалом maxBackoffDuration, до достижения значения retryCount.

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

maxRetryDuration

string

Ограничение по времени для повторных попыток выполнения задания после сбоя, отсчитываемое с момента первой попытки выполнения. Если задано вместе с retryCount, повторные попытки будут выполняться до достижения обоих ограничений.

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

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

minBackoffDuration

string

Минимальное время ожидания перед повторной попыткой выполнить задание после сбоя.

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

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

retryCount

integer

Количество попыток, которые система предпримет для выполнения задания с использованием процедуры экспоненциальной задержки, описанной в maxDoublings.

Значения больше 5 и отрицательные значения не допускаются.

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

schedule

string

Описывает расписание выполнения задания.

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

timeZone

string

Задаёт часовой пояс, используемый при интерпретации расписания.

Значение этого поля должно быть названием часового пояса из базы данных tz.

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