RuntimeOptions interface

Параметры конфигурации функции, применимые во время выполнения.

Подпись:

export interface RuntimeOptions 

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

RuntimeOptions.consumeAppCheckToken

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

Установите для этого параметра значение true, чтобы включить функцию защиты воспроизведения проверки приложений, используя токен проверки приложений по вызываемому запросу. Для токенов, которые уже использованы, для свойства request.app.alreadyConsumed установлено значение true.

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

Эта функция защиты от повтора требует дополнительного сетевого вызова к серверной части проверки приложений и заставляет клиентов получать новое подтверждение от выбранных поставщиков подтверждения. Таким образом, это может отрицательно повлиять на производительность и потенциально может привести к более быстрому исчерпанию квот ваших поставщиков аттестации. Используйте эту функцию только для защиты небольших объемов, критически важных для безопасности или дорогостоящих операций.

Этот параметр не влияет на параметр enforceAppCheck . Установка для последнего значения true приведет к тому, что вызываемая функция автоматически ответит кодом состояния 401 Unauthorized, когда запрос включает недействительный токен проверки приложения. Если запрос включает действительные, но использованные токены проверки приложений, запросы не будут автоматически отклонены. Вместо этого для свойства request.app.alreadyConsumed будет установлено значение true, и выполнение будет передано коду обработчика для принятия дальнейших решений, таких как требование дополнительных проверок безопасности или отклонение запроса.

Подпись:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Определяет, применяется ли Firebase AppCheck.

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

Подпись:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Политика отказа функции, где логическое значение true эквивалентно предоставлению пустого объекта повтора.

Подпись:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

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

Подпись:

ingressSettings?: (typeof INGRESS_SETTINGS_OPTIONS)[number] | ResetValue;

RuntimeOptions.invoker

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

Подпись:

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

RuntimeOptions.labels

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

Подпись:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

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

Подпись:

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

RuntimeOptions.memory

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

Подпись:

memory?: (typeof VALID_MEMORY_OPTIONS)[number] | Expression<number> | ResetValue;

RuntimeOptions.minInstances

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

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

Подпись:

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

RuntimeOptions.preserveExternalChanges

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

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

Подпись:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

Подпись:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

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

Подпись:

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

RuntimeOptions.timeoutSeconds

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

Подпись:

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

RuntimeOptions.vpcConnector

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

Подпись:

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

RuntimeOptions.vpcConnectorEgressSettings

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

Подпись:

vpcConnectorEgressSettings?: (typeof VPC_EGRESS_SETTINGS_OPTIONS)[number] | ResetValue;

Параметры конфигурации функции, применимые во время выполнения.

Подпись:

export interface RuntimeOptions 

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

RuntimeOptions.consumeAppCheckToken

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

Установите для этого параметра значение true, чтобы включить функцию защиты воспроизведения проверки приложений, используя токен проверки приложений по вызываемому запросу. Для токенов, которые уже использованы, для свойства request.app.alreadyConsumed установлено значение true.

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

Эта функция защиты от повтора требует дополнительного сетевого вызова к серверной части проверки приложений и заставляет клиентов получать новое подтверждение от выбранных поставщиков подтверждения. Таким образом, это может отрицательно повлиять на производительность и потенциально может привести к более быстрому исчерпанию квот ваших поставщиков аттестации. Используйте эту функцию только для защиты небольших объемов, критически важных для безопасности или дорогостоящих операций.

Этот параметр не влияет на параметр enforceAppCheck . Установка для последнего значения true приведет к тому, что вызываемая функция автоматически ответит кодом состояния 401 Unauthorized, когда запрос включает недействительный токен проверки приложения. Если запрос включает действительные, но использованные токены проверки приложений, запросы не будут автоматически отклонены. Вместо этого для свойства request.app.alreadyConsumed будет установлено значение true, и выполнение будет передано коду обработчика для принятия дальнейших решений, таких как требование дополнительных проверок безопасности или отклонение запроса.

Подпись:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Определяет, применяется ли Firebase AppCheck.

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

Подпись:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Политика отказа функции, где логическое значение true эквивалентно предоставлению пустого объекта повтора.

Подпись:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

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

Подпись:

ingressSettings?: (typeof INGRESS_SETTINGS_OPTIONS)[number] | ResetValue;

RuntimeOptions.invoker

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

Подпись:

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

RuntimeOptions.labels

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

Подпись:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

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

Подпись:

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

RuntimeOptions.memory

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

Подпись:

memory?: (typeof VALID_MEMORY_OPTIONS)[number] | Expression<number> | ResetValue;

RuntimeOptions.minInstances

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

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

Подпись:

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

RuntimeOptions.preserveExternalChanges

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

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

Подпись:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

Подпись:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

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

Подпись:

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

RuntimeOptions.timeoutSeconds

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

Подпись:

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

RuntimeOptions.vpcConnector

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

Подпись:

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

RuntimeOptions.vpcConnectorEgressSettings

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

Подпись:

vpcConnectorEgressSettings?: (typeof VPC_EGRESS_SETTINGS_OPTIONS)[number] | ResetValue;