RuntimeOptions interface

Opciones de configuración para una función aplicable en tiempo de ejecución.

Firma:

export interface RuntimeOptions 

Propiedades

Propiedad	Tipo	Descripción
consumirAppCheckToken	booleano	Determina si el token de Firebase App Check se consume a pedido. El valor predeterminado es falso.
hacer cumplirAppCheck	booleano	Determina si se aplica Firebase AppCheck.
política de fracaso	Política de fracaso | booleano	Política de error de la función, siendo booleano true equivalente a proporcionar un objeto de reintento vacío.
configuración de ingreso	(tipo de INGRESS_SETTINGS_OPTIONS )[número] | Restablecer valor	Configuraciones de ingreso que controlan desde dónde se puede llamar a esta función.
invocador	"público" | "privado" | cadena | cadena[]	Invocador para establecer el control de acceso a las funciones https.
etiquetas	Grabar<cadena,cadena>	Etiquetas de usuario para configurar en la función.
maxInstancias	número | Expresión <número> | Restablecer valor	Número máximo de instancias reales que se pueden ejecutar en paralelo.
memoria	(tipo de VALID_MEMORY_OPTIONS )[número] | Expresión <número> | Restablecer valor	Cantidad de memoria para asignar a la función.
minInstancias	número | Expresión <número> | Restablecer valor	Número mínimo de instancias reales que se ejecutarán en un momento dado.
preservar cambios externos	booleano	Controla si se conserva la configuración de la función modificada fuera del origen de la función. El valor predeterminado es falso.
misterios	(cadena | SecretParam)[]
cuenta de servicio	"predeterminado" | cadena | Expresión <cadena> | Restablecer valor	Cuenta de servicio específica para que se ejecute la función.
tiempo de esperaSegundos	número | Expresión <número> | Restablecer valor	Tiempo de espera de la función en segundos, los valores posibles son de 0 a 540.
vpcConector	cadena | Expresión <cadena> | Restablecer valor	Conecte la función de nube al conector VPC especificado.
vpcConnectorEgressConfiguración	(tipo de VPC_EGRESS_SETTINGS_OPTIONS )[número] | Restablecer valor	Configuración de salida para el conector VPC.

RuntimeOptions.consumeAppCheckToken

Determina si el token de Firebase App Check se consume a pedido. El valor predeterminado es falso.

Establezca esto en verdadero para habilitar la función de protección de reproducción de App Check consumiendo el token de App Check en una solicitud invocable. Los tokens que ya se hayan consumido tendrán la propiedad request.app.alreadyConsumed establecida en verdadero.

Los tokens solo se consideran consumidos si se envían al servicio App Check configurando esta opción en verdadero. Otros usos del token no lo consumen.

Esta función de protección de reproducción requiere una llamada de red adicional al backend de App Check y obliga a los clientes a obtener una certificación nueva de los proveedores de certificación elegidos. Por lo tanto, esto puede afectar negativamente al rendimiento y potencialmente agotar las cuotas de sus proveedores de certificación más rápidamente. Utilice esta función solo para proteger operaciones de bajo volumen, críticas para la seguridad o costosas.

Esta opción no afecta la opción enforceAppCheck . Establecer este último en verdadero hará que la función invocable responda automáticamente con un código de estado 401 No autorizado cuando la solicitud incluya un token de verificación de aplicación no válido. Cuando la solicitud incluye tokens de App Check válidos pero consumidos, las solicitudes no se rechazarán automáticamente. En su lugar, la propiedad request.app.alreadyConsumed se establecerá en verdadero y pasará la ejecución al código del controlador para tomar decisiones adicionales, como requerir controles de seguridad adicionales o rechazar la solicitud.

Firma:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

Determina si se aplica Firebase AppCheck.

Cuando es verdadero, las solicitudes con tokens no válidos responden automáticamente con un error 401 (no autorizado). Cuando es falso, las solicitudes con tokens no válidos configuran context.app como indefiend.

Firma:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Política de error de la función, siendo booleano true equivalente a proporcionar un objeto de reintento vacío.

Firma:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

Configuraciones de ingreso que controlan desde dónde se puede llamar a esta función.

Firma:

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

Opciones de tiempo de ejecución.invoker

Invocador para establecer el control de acceso a las funciones https.

Firma:

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

Opciones de tiempo de ejecución.etiquetas

Etiquetas de usuario para configurar en la función.

Firma:

labels?: Record<string, string>;

RuntimeOptions.maxInstancias

Número máximo de instancias reales que se pueden ejecutar en paralelo.

Firma:

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

Opciones de tiempo de ejecución.memoria

Cantidad de memoria para asignar a la función.

Firma:

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

RuntimeOptions.minInstancias

Número mínimo de instancias reales que se ejecutarán en un momento dado.

A las instancias se les facturará la asignación de memoria y el 10 % de la asignación de CPU mientras estén inactivas.

Firma:

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

RuntimeOptions.preserveExternalChanges

Controla si se conserva la configuración de la función modificada fuera del origen de la función. El valor predeterminado es falso.

Al configurar la configuración disponible en la plataforma subyacente que aún no está disponible en el SDK de Firebase Functions, recomendamos configurar preserveExternalChanges en true . De lo contrario, cuando el SDK de Firebase Functions publique una nueva versión del SDK compatible con la configuración que falta, es posible que la configuración configurada manualmente de su función se borre sin darse cuenta.

Firma:

preserveExternalChanges?: boolean;

Opciones de tiempo de ejecución.secretos

Firma:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

Cuenta de servicio específica para que se ejecute la función.

Firma:

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

RuntimeOptions.timeoutSeconds

Tiempo de espera de la función en segundos, los valores posibles son de 0 a 540.

Firma:

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

RuntimeOptions.vpcConnector

Conecte la función de nube al conector VPC especificado.

Firma:

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

RuntimeOptions.vpcConnectorEgressSettings

Configuración de salida para el conector VPC.

Firma:

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