GlobalOptions — это параметры, которые можно установить для всего проекта. Эти параметры являются общими для HTTPS и функций обработки событий.
Подпись:
export interface GlobalOptions
Характеристики
Свойство | Тип | Описание |
---|---|---|
параллелизм | номер | Выражение<число> | Сбросить значение | Количество запросов, которые функция может обслуживать одновременно. |
Процессор | номер | "gcf_gen1" | Дробное количество процессоров, выделяемых функции. |
применять AppCheck | логический | Определяет, применяется ли Firebase AppCheck. По умолчанию ложно. |
входные настройки | IngressSetting | Сбросить значение | Входные настройки, которые определяют, откуда может быть вызвана эта функция. |
вызывающий | "общественность" | "частный" | строка | нить[] | Invoker для установки контроля доступа к функциям https. |
этикетки | Запись<строка, строка> | Пользовательские метки для установки функции. |
maxInstances | номер | Выражение<число> | Сбросить значение | Максимальное количество экземпляров, которые будут работать параллельно. |
Память | ПамятьОпция | Выражение<число> | Сбросить значение | Объем памяти, выделяемый функции. |
minInstances | номер | Выражение<число> | Сбросить значение | Минимальное количество фактических экземпляров, которые будут запущены в данный момент времени. |
пропускать | логический | Выражение<логическое> | Если это правда, не развертывайте и не эмулируйте эту функцию. |
сохранитьExternalChanges | логический | Определяет, сохраняется ли конфигурация функции, измененная вне источника функции. По умолчанию ложно. |
область | Поддерживаемый регион | нить | Регион, в котором должны быть развернуты функции. |
секреты | (строка | секретный параметр)[] | |
serviceAccount | строка | Сбросить значение | Конкретная учетная запись службы для запуска функции. |
timeoutSeconds | номер | Выражение<число> | Сбросить значение | Время ожидания для функции в секундах, возможные значения от 0 до 540. Функции HTTPS могут указывать большее время ожидания. |
vpcConnector | строка | Выражение<строка> | Сбросить значение | Подключите облачную функцию к указанному коннектору VPC. |
vpcConnectorEgressSettings | VpcEgressSetting | Сбросить значение | Параметры исходящего трафика для коннектора VPC. |
GlobalOptions.concurrency
Количество запросов, которые функция может обслуживать одновременно.
Может применяться только к функциям, работающим в Cloud Functions v2. Значение null восстанавливает параллелизм по умолчанию (80, когда ЦП > = 1, иначе 1). Для параллелизма нельзя установить значение, отличное от 1, если cpu
меньше 1. Максимальное значение для параллелизма — 1000.
Подпись:
concurrency?: number | Expression<number> | ResetValue;
GlobalOptions.cpu
Дробное количество процессоров, выделяемых функции.
По умолчанию 1 для функций с < = 2 ГБ ОЗУ и увеличивается для больших объемов памяти. Это отличается от значений по умолчанию при использовании утилиты gcloud и отличается от фиксированного объема, назначенного в Google Cloud Functions поколения 1. Чтобы вернуться к объемам ЦП, используемым в gcloud или в Cloud Functions поколения 1, установите для него значение «gcf_gen1».
Подпись:
cpu?: number | "gcf_gen1";
GlobalOptions.enforceAppCheck
Определяет, применяется ли Firebase AppCheck. По умолчанию ложно.
Если задано значение true, запросы с недопустимыми токенами автоматически отвечают с ошибкой 401 (Unauthorized). При значении false запросы с недопустимыми токенами устанавливают для event.app значение undefiend.
Подпись:
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?: boolean | Expression<boolean>;
GlobalOptions.preserveExternalChanges
Определяет, сохраняется ли конфигурация функции, измененная вне источника функции. По умолчанию ложно.
При настройке конфигурации, доступной на базовой платформе, которая еще недоступна в SDK Firebase Functions, мы настоятельно рекомендуем установить для параметра preserveExternalChanges
значение true
. В противном случае, когда Firebase Functions SDK выпустит новую версию SDK с поддержкой отсутствующей конфигурации, настройка вашей функции, настроенная вручную, может быть непреднамеренно удалена.
Подпись:
preserveExternalChanges?: boolean;
GlobalOptions.region
Регион, в котором должны быть развернуты функции.
Подпись:
region?: SupportedRegion | string;
GlobalOptions.secrets
Подпись:
secrets?: (string | SecretParam)[];
GlobalOptions.serviceAccount
Конкретная учетная запись службы для запуска функции.
Подпись:
serviceAccount?: 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;