GlobalOptions son opciones que se pueden establecer en todo un proyecto. Estas opciones son comunes a HTTPS y funciones de manejo de eventos.
Firma:
export interface GlobalOptions
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| simultaneidad | número | Expresión <número> | Restablecer valor | Número de solicitudes que una función puede atender a la vez. |
| UPC | número | "gcf_gen1" | Número fraccional de CPU para asignar a una función. |
| hacer cumplirAppCheck | booleano | Determina si se aplica Firebase App Check. El valor predeterminado es falso. |
| configuración de ingreso | Configuración de ingreso | Restablecer valor | Ajustes de entrada 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 en las funciones HTTPS. |
| etiquetas | Registro<cadena, cadena> | Etiquetas de usuario para establecer en la función. |
| maxInstances | número | Expresión <número> | Restablecer valor | Número máximo de instancias que se pueden ejecutar en paralelo. |
| memoria | Opción de memoria | Expresión <número> | Restablecer valor | Cantidad de memoria para asignar a una función. |
| instancias mínimas | número | Expresión <número> | Restablecer valor | Número mínimo de instancias reales que se ejecutarán en un momento dado. |
| omitir | booleano | Expresión <booleano> | Si es verdadero, no implemente ni emule esta función. |
| preservarCambiosExternos | 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. |
| región | Región admitida | cadena | Expresión <cadena> | Restablecer valor | Región donde se deben desplegar las funciones. |
| misterios | (cadena | SecretParam)[] | |
| cuenta de servicio | 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 para la función en segundos, los valores posibles son de 0 a 540. Las funciones HTTPS pueden especificar un tiempo de espera mayor. |
| conector vpc | cadena | Expresión <cadena> | Restablecer valor | Conecte una función a un conector de VPC especificado. |
| vpcConnectorEgressSettings | Configuración de salida de Vpc | Restablecer valor | Configuración de salida para el conector de VPC. |
GlobalOptions.concurrencia
Número de solicitudes que una función puede atender a la vez.
Solo se puede aplicar a las funciones que se ejecutan en Cloud Functions (2.ª generación)). Un valor nulo restaura la concurrencia predeterminada (80 cuando CPU > = 1, 1 en caso contrario). La simultaneidad no se puede establecer en ningún valor que no sea 1 si cpu es inferior a 1. El valor máximo para la simultaneidad es 1000.
Firma:
concurrency?: number | Expression<number> | ResetValue;
GlobalOptions.cpu
Número fraccional de CPU para asignar a una función.
El valor predeterminado es 1 para funciones con < = 2 GB de RAM y aumenta para tamaños de memoria más grandes. Esto es diferente de los valores predeterminados cuando se usa la utilidad gcloud y es diferente de la cantidad fija asignada en Cloud Functions (1ra generación). Para volver a las cantidades de CPU utilizadas en gcloud o en Cloud Functions (1.ª generación), establezca esto en el valor "gcf_gen1"
Firma:
cpu?: number | "gcf_gen1";
GlobalOptions.enforceAppCheck
Determina si se aplica Firebase App Check. El valor predeterminado es falso.
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 event.app como undefined .
Firma:
enforceAppCheck?: boolean;
GlobalOptions.ingressSettings
Ajustes de entrada que controlan desde dónde se puede llamar a esta función.
Firma:
ingressSettings?: IngressSetting | ResetValue;
GlobalOptions.invoker
Invocador para establecer el control de acceso en las funciones HTTPS.
Firma:
invoker?: "public" | "private" | string | string[];
GlobalOptions.labels
Etiquetas de usuario para establecer en la función.
Firma:
labels?: Record<string, string>;
GlobalOptions.maxInstances
Número máximo de instancias que se pueden ejecutar en paralelo.
Firma:
maxInstances?: number | Expression<number> | ResetValue;
GlobalOptions.memoria
Cantidad de memoria para asignar a una función.
Firma:
memory?: MemoryOption | Expression<number> | ResetValue;
GlobalOptions.minInstances
Número mínimo de instancias reales que se ejecutarán en un momento dado.
Las instancias se facturan 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;
GlobalOptions.omit
Si es verdadero, no implemente ni emule esta función.
Firma:
omit?: boolean | Expression<boolean>;
GlobalOptions.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 una plataforma subyacente que aún no está disponible en el SDK de Firebase para Cloud Functions, recomendamos configurar preserveExternalChanges en true . De lo contrario, cuando Google publique una nueva versión del SDK compatible con la configuración faltante, es posible que la configuración configurada manualmente de su función desaparezca sin darse cuenta.
Firma:
preserveExternalChanges?: boolean;
GlobalOptions.región
Región donde se deben desplegar las funciones.
Firma:
region?: SupportedRegion | string | Expression<string> | ResetValue;
GlobalOptions.secretos
Firma:
secrets?: (string | SecretParam)[];
GlobalOptions.serviceAccount
Cuenta de servicio específica para que se ejecute la función.
Firma:
serviceAccount?: string | Expression<string> | ResetValue;
GlobalOptions.timeoutSeconds
Tiempo de espera para la función en segundos, los valores posibles son de 0 a 540. Las funciones HTTPS pueden especificar un tiempo de espera mayor.
El tiempo de espera mínimo para una función de segunda generación es de 1 s. El tiempo de espera máximo para una función depende del tipo de función: Las funciones de gestión de eventos tienen un tiempo de espera máximo de 540 s (9 minutos). HTTPS y las funciones a las que se puede llamar tienen un tiempo de espera máximo de 36,00 s (1 hora). Las funciones de la cola de tareas tienen un tiempo de espera máximo de 1800 s (30 minutos).
Firma:
timeoutSeconds?: number | Expression<number> | ResetValue;
GlobalOptions.vpcConector
Conecte una función a un conector de VPC especificado.
Firma:
vpcConnector?: string | Expression<string> | ResetValue;
GlobalOptions.vpcConnectorEgressSettings
Configuración de salida para el conector de VPC.
Firma:
vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;