GlobalOptions interface

GlobalOptions — это параметры, которые можно установить для всего проекта. Эти параметры являются общими для HTTPS и функций обработки событий.

Подпись:

export interface GlobalOptions 

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

Свойство Тип Описание
параллелизм номер | Выражение <номер> | Сбросить значение Количество запросов, которые функция может обслужить одновременно.
Процессор номер | "gcf_gen1" Дробное количество процессоров, выделяемых для функции.
применятьAppCheck логическое значение Определяет, применяется ли проверка приложений Firebase. По умолчанию ложь.
входные настройки IngressSetting | Сбросить значение Настройки входа, которые определяют, откуда можно вызвать эту функцию.
вызывающий "общественный" | "частный" | строка | нить[] Invoker для установки контроля доступа к функциям HTTPS.
этикетки Запись<строка, строка> Ярлыки пользователей, которые можно установить для функции.
maxInstances номер | Выражение <номер> | Сбросить значение Максимальное количество экземпляров, которые могут работать параллельно.
память Опция памяти | Выражение <номер> | Сбросить значение Объем памяти, выделяемый для функции.
минэкземпляры номер | Выражение <номер> | Сбросить значение Минимальное количество фактических экземпляров, которые будут работать в данный момент.
пропускать логическое | Выражение <логическое значение> Если это правда, не развертывайте и не эмулируйте эту функцию.
сохранитьExternalChanges логическое значение Определяет, сохраняется ли конфигурация функции, измененная за пределами источника функции. По умолчанию ложь.
область Поддерживаемый регион | строка | Выражение <строка> | Сбросить значение Регион, в котором должны быть развернуты функции.
секреты (строка | СекретныйПарам)[]
сервисаккаунт строка | Выражение <строка> | Сбросить значение Конкретная учетная запись службы, от имени которой будет выполняться функция.
таймаутСекунды номер | Выражение <номер> | Сбросить значение Тайм-аут функции в секундах, возможные значения: от 0 до 540. Для функций HTTPS можно указать более высокий тайм-аут.
vpcConnector строка | Выражение <строка> | Сбросить значение Подключите функцию к указанному соединителю VPC.
vpcConnectorEgressSettings Настройка VpcEgressSetting | Сбросить значение Настройки исходящего трафика для соединителя VPC.

GlobalOptions.concurrency

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

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

Подпись:

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

GlobalOptions.cpu

Дробное количество процессоров, выделяемых для функции.

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

Подпись:

cpu?: number | "gcf_gen1";

GlobalOptions.enforceAppCheck

Определяет, применяется ли проверка приложений Firebase. По умолчанию ложь.

Если это значение истинно, запросы с недействительными токенами автоматически отвечают с ошибкой 401 (несанкционировано). Если значение false, запросы с недействительными токенами присваивают event.app значение undefined .

Подпись:

enforceAppCheck?: boolean;

GlobalOptions.ingressSettings

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

Подпись:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.invoker

Invoker для установки контроля доступа к функциям HTTPS.

Подпись:

invoker?: "public" | "private" | string | string[];

GlobalOptions.labels

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

Подпись:

labels?: Record<string, string>;

GlobalOptions.maxInstances

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

Подпись:

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

GlobalOptions.memory

Объем памяти, выделяемый для функции.

Подпись:

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

GlobalOptions.minInstances

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

Счета за экземпляры взимаются за выделение памяти и 10 % за использование ЦП во время простоя.

Подпись:

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

GlobalOptions.omit

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

Подпись:

omit?: boolean | Expression<boolean>;

GlobalOptions.preserveExternalChanges

Определяет, сохраняется ли конфигурация функции, измененная за пределами источника функции. По умолчанию ложь.

При настройке конфигурации, доступной на базовой платформе, которая еще не доступна в Firebase SDK для облачных функций, мы рекомендуем установить для preserveExternalChanges значение true . В противном случае, когда Google выпустит новую версию SDK с поддержкой отсутствующей конфигурации, настройки вашей функции, настроенные вручную, могут быть случайно удалены.

Подпись:

preserveExternalChanges?: boolean;

GlobalOptions.регион

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

Подпись:

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

GlobalOptions.secrets

Подпись:

secrets?: (string | SecretParam)[];

GlobalOptions.serviceAccount

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

Подпись:

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

GlobalOptions.timeoutSeconds

Тайм-аут функции в секундах, возможные значения: от 0 до 540. Для функций HTTPS можно указать более высокий тайм-аут.

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

Подпись:

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

GlobalOptions.vpcConnector

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

Подпись:

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

GlobalOptions.vpcConnectorEgressSettings

Настройки исходящего трафика для соединителя VPC.

Подпись:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;