RuntimeOptions interface

Opciones de configuración para una función que se aplica en el entorno de ejecución.

Firma:

export interface RuntimeOptions

Propiedades

Propiedad Tipo Descripción
consumeAppCheckToken booleano Determina si el token de la Verificación de aplicaciones de Firebase se consume en una solicitud. La configuración predeterminada es "false".
aplicar la verificación de aplicaciones booleano Determina si se aplica Firebase AppCheck.
failurePolicy FailurePolicy | booleano Política de fallas de la función, con el booleano true que equivale a proporcionar un objeto de reintento vacío.
ingressSettings (tipo de INGRESS_CONFIG_OPTIONS)[número] | RestablecerValor Son parámetros de configuración de entrada que controlan desde dónde se puede llamar a esta función.
invocador “público” | “privado” | cadena | cadena Invocador para configurar el control de acceso en las funciones HTTPS.
etiquetas Registro<cadena, cadena> Son las etiquetas de usuario que se deben configurar en la función.
instanciasmax número | Expresión<número> | RestablecerValor Cantidad máxima de instancias reales que se pueden ejecutar en paralelo.
memoria (tipo de VALID_MEMORY_OPTIONS)[número] | Expresión<número> | RestablecerValor Cantidad de memoria para asignar a la función.
instanciasmin número | Expresión<número> | RestablecerValor Cantidad mínima de instancias reales que se ejecutarán en un momento determinado.
conservación de los cambios externos booleano Controla si se conserva la configuración modificada de la función fuera de la fuente de la función. La configuración predeterminada es "false".
secretos (cadena | SecretParam)[]
serviceAccount “predeterminado” | cadena | Expresión<string> | RestablecerValor Cuenta de servicio específica con la que se ejecutará la función.
timeoutSeconds número | Expresión<número> | RestablecerValor Es el tiempo de espera de la función en segundos. Los valores posibles son de 0 a 540.
vpcConnector cadena | Expresión<string> | RestablecerValor Conecta la Cloud Function al conector de VPC especificado.
vpcConnectorEgressSettings (tipo de VPC_EGRESS_OPTIONS_OPTIONS)[número] | RestablecerValor Configuración de salida para el conector de VPC.

RuntimeOptions.consumeAppCheckToken

Determina si el token de la Verificación de aplicaciones de Firebase se consume en una solicitud. La configuración predeterminada es "false".

Establece esta opción como verdadera para habilitar la función de protección contra la repetición de la Verificación de aplicaciones con el consumo del token de la Verificación de aplicaciones en una solicitud que admite llamadas. La propiedad request.app.alreadyConsumed se establecerá en verdadero para los tokens que ya se consumieron.

Los tokens solo se consideran que se consumen si se envían al servicio de la Verificación de aplicaciones. Para ello, se debe configurar esta opción como verdadera. Otros usos del token no lo consumen.

Esta función de protección contra la repetición requiere una llamada de red adicional al backend de la Verificación de aplicaciones y obliga a los clientes a obtener una certificación nueva de los proveedores de certificación elegidos. Por lo tanto, esto puede tener un impacto negativo en el rendimiento y es posible que se agote el tiempo de ejecución de tus proveedores de certificación. cuotas de forma más rápida. Usa esta función solo para proteger operaciones de bajo volumen, que son críticas para la seguridad o costosas.

Esta opción no afecta a la opción enforceAppCheck. Si estableces esta última opción como verdadera, la función que admite llamadas responderá automáticamente con un código de estado 401 No autorizado cuando la solicitud incluya un token no válido de Verificación de aplicaciones. Si la solicitud incluye tokens válidos pero consumidos de la Verificación de aplicaciones, las solicitudes no se rechazarán automáticamente. En su lugar, la propiedad request.app.alreadyConsumed se establecerá como verdadera y pasará la ejecución al código del controlador para tomar más decisiones, como requerir verificaciones 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 falsa, las solicitudes con tokens no válidos configuran context.app como indefiend.

Firma:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

Política de fallas de la función, con el booleano true que equivale a proporcionar un objeto de reintento vacío.

Firma:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

Son parámetros de configuración de entrada que controlan desde dónde se puede llamar a esta función.

Firma:

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

entorno de ejecución.Invocador

Invocador para configurar el control de acceso en las funciones HTTPS.

Firma:

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

RuntimeOptions.labels

Son las etiquetas de usuario que se deben configurar en la función.

Firma:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

Cantidad máxima de instancias reales que se pueden ejecutar en paralelo.

Firma:

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

RuntimeOptions.memory

Cantidad de memoria para asignar a la función.

Firma:

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

RuntimeOptions.minInstances

Cantidad mínima de instancias reales que se ejecutarán en un momento determinado.

Las instancias se facturarán por 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 modificada de la función fuera de la fuente de la función. La configuración predeterminada es "false".

Cuando establezcas la configuración disponible en la plataforma subyacente que aún no está disponible en el SDK de Firebase Functions, te recomendamos establecer preserveExternalChanges en true. De lo contrario, cuando el SDK de Firebase Functions lanza una nueva versión del SDK compatible con la configuración faltante, es posible que la configuración manual de la función se borre sin darte cuenta.

Firma:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

Firma:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount.

Cuenta de servicio específica con la que se ejecutará la función.

Firma:

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

RuntimeOptions.timeoutSeconds

Es el 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

Conecta la Cloud Function al conector de VPC especificado.

Firma:

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

RuntimeOptions.vpcConnectorEgressSettings

Configuración de salida para el conector de VPC.

Firma:

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