alerts.FirebaseAlertOptions interface

Конфигурация функций оповещений Firebase.

Подпись:

export interface FirebaseAlertOptions extends options.EventHandlerOptions 

Расширяет: options.EventHandlerOptions

Характеристики

Свойство Тип Описание
тип оповещения Тип оповещения Определите область действия обработчика для срабатывания по типу оповещения.
идентификатор приложения нить Определите область действия функции для запуска в конкретном приложении.
параллелизм номер | Выражение <номер> | Сбросить значение Количество запросов, которые функция может обслужить одновременно. Может применяться только к функциям, работающим в Cloud Functions v2. Значение null восстанавливает параллелизм по умолчанию (80, когда ЦП > = 1, 1 в противном случае). Для параллелизма не может быть установлено любое значение, кроме 1, если cpu меньше 1. Максимальное значение для параллелизма — 1000.
Процессор номер | "gcf_gen1" Дробное количество процессоров, выделяемых для функции. По умолчанию 1 для функций с < = 2 ГБ ОЗУ и увеличивается при увеличении объема памяти. Это отличается от значений по умолчанию при использовании утилиты gcloud и отличается от фиксированного количества, назначенного в Google Cloud Functions поколения 1. Чтобы вернуться к объемам ЦП, используемым в gcloud или в Cloud Functions поколения 1, установите для этого значения значение «gcf_gen1».
входные настройки параметры.IngressSetting | Сбросить значение Настройки входа, которые определяют, откуда можно вызвать эту функцию. Значение null отключает настройки входящего трафика.
этикетки Запись<строка, строка> Ярлыки пользователей, которые можно установить для функции.
maxInstances номер | Выражение <номер> | Сбросить значение Максимальное количество экземпляров, которые будут работать параллельно. Значение null восстанавливает максимальное количество экземпляров по умолчанию.
память параметры.MemoryOption | Выражение <номер> | Сбросить значение Объем памяти, выделяемый функции. Значение null восстанавливает значение по умолчанию — 256 МБ.
минэкземпляры номер | Выражение <номер> | Сбросить значение Минимальное количество фактических экземпляров, которые будут работать в данный момент. С экземпляров будет взиматься плата за выделение памяти и 10 % за использование ЦП во время простоя. Значение null восстанавливает минимальные экземпляры по умолчанию.
пропускать логическое | Выражение <логическое значение> Если это правда, не развертывайте и не эмулируйте эту функцию.
область options.SupportedRegion | строка | Выражение <строка> | Сбросить значение Регион, в котором должны быть развернуты функции.
повторить попытку логическое | Выражение <логическое значение> | Сбросить значение Должны ли неудачные исполнения быть доставлены снова.
секреты (строка | СекретныйПарам)[]
сервисаккаунт строка | Выражение <строка> | Сбросить значение Конкретная учетная запись службы, от имени которой будет выполняться функция. Значение null восстанавливает учетную запись службы по умолчанию.
таймаутСекунды номер | Выражение <номер> | Сбросить значение Тайм-аут функции в секундах, возможные значения: от 0 до 540. Для функций HTTPS можно указать более высокий тайм-аут. Значение null восстанавливает значение по умолчанию, равное 60 с. Минимальное время ожидания для функции поколения 2 составляет 1 с. Максимальное время ожидания функции зависит от типа функции: Максимальное время ожидания функций обработки событий составляет 540 с (9 минут). Максимальное время ожидания HTTPS и вызываемых функций составляет 36,00 с (1 час). Функции очереди задач имеют максимальное время ожидания 1800 с (30 минут).
vpcConnector строка | Выражение <строка> | Сбросить значение Подключите облачную функцию к указанному соединителю VPC. Значение null удаляет соединитель VPC.
vpcConnectorEgressSettings options.VpcEgressSetting | Сбросить значение Настройки исходящего трафика для соединителя VPC. Значение null отключает настройки выходного разъема VPC.

alerts.FirebaseAlertOptions.alertType

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

Подпись:

alertType: AlertType;

alerts.FirebaseAlertOptions.appId

Определите область действия функции для запуска в конкретном приложении.

Подпись:

appId?: string;

alerts.FirebaseAlertOptions.concurrency

Количество запросов, которые функция может обслужить одновременно. Может применяться только к функциям, работающим в Cloud Functions v2. Значение null восстанавливает параллелизм по умолчанию (80, когда ЦП > = 1, 1 в противном случае). Для параллелизма не может быть установлено любое значение, кроме 1, если cpu меньше 1. Максимальное значение для параллелизма — 1000.

Подпись:

concurrency?: number | Expression<number> | ResetValue;

alerts.FirebaseAlertOptions.cpu

Дробное количество процессоров, выделяемых для функции. По умолчанию 1 для функций с < = 2 ГБ ОЗУ и увеличивается при увеличении объема памяти. Это отличается от значений по умолчанию при использовании утилиты gcloud и отличается от фиксированного количества, назначенного в Google Cloud Functions поколения 1. Чтобы вернуться к объемам ЦП, используемым в gcloud или в Cloud Functions поколения 1, установите для этого значения значение «gcf_gen1».

Подпись:

cpu?: number | "gcf_gen1";

alerts.FirebaseAlertOptions.ingressSettings

Настройки входа, которые определяют, откуда можно вызвать эту функцию. Значение null отключает настройки входящего трафика.

Подпись:

ingressSettings?: options.IngressSetting | ResetValue;

alerts.FirebaseAlertOptions.labels

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

Подпись:

labels?: Record<string, string>;

alerts.FirebaseAlertOptions.maxInstances

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

Подпись:

maxInstances?: number | Expression<number> | ResetValue;

alerts.FirebaseAlertOptions.memory

Объем памяти, выделяемый функции. Значение null восстанавливает значение по умолчанию — 256 МБ.

Подпись:

memory?: options.MemoryOption | Expression<number> | ResetValue;

alerts.FirebaseAlertOptions.minInstances

Минимальное количество фактических экземпляров, которые будут работать в данный момент. С экземпляров будет взиматься плата за выделение памяти и 10 % за использование ЦП во время простоя. Значение null восстанавливает минимальные экземпляры по умолчанию.

Подпись:

minInstances?: number | Expression<number> | ResetValue;

alerts.FirebaseAlertOptions.omit

Если это правда, не развертывайте и не эмулируйте эту функцию.

Подпись:

omit?: boolean | Expression<boolean>;

alerts.FirebaseAlertOptions.region

Регион, в котором должны быть развернуты функции.

Подпись:

region?: options.SupportedRegion | string | Expression<string> | ResetValue;

alerts.FirebaseAlertOptions.retry

Должны ли неудачные исполнения быть доставлены снова.

Подпись:

retry?: boolean | Expression<boolean> | ResetValue;

alerts.FirebaseAlertOptions.secrets

Подпись:

secrets?: (string | SecretParam)[];

alerts.FirebaseAlertOptions.serviceAccount

Конкретная учетная запись службы, от имени которой будет выполняться функция. Значение null восстанавливает учетную запись службы по умолчанию.

Подпись:

serviceAccount?: string | Expression<string> | ResetValue;

alerts.FirebaseAlertOptions.timeoutSeconds

Тайм-аут функции в секундах, возможные значения: от 0 до 540. Для функций HTTPS можно указать более высокий тайм-аут. Значение null восстанавливает значение по умолчанию, равное 60 с. Минимальное время ожидания для функции поколения 2 составляет 1 с. Максимальное время ожидания функции зависит от типа функции: Максимальное время ожидания функций обработки событий составляет 540 с (9 минут). Максимальное время ожидания HTTPS и вызываемых функций составляет 36,00 с (1 час). Функции очереди задач имеют максимальное время ожидания 1800 с (30 минут).

Подпись:

timeoutSeconds?: number | Expression<number> | ResetValue;

alerts.FirebaseAlertOptions.vpcConnector

Подключите облачную функцию к указанному соединителю VPC. Значение null удаляет соединитель VPC.

Подпись:

vpcConnector?: string | Expression<string> | ResetValue;

alerts.FirebaseAlertOptions.vpcConnectorEgressSettings

Настройки исходящего трафика для соединителя VPC. Значение null отключает настройки выходного разъема VPC.

Подпись:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;