GlobalOptions interface

GlobalOptions son opciones que se pueden configurar en todo un proyecto. Estas opciones son comunes a HTTPS y a las funciones de manejo de eventos.

Firma:

export interface GlobalOptions 

Propiedades

Propiedad	Tipo	Descripción
concurrencia	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 fraccionario 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	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 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.
minInstancias	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.
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.
región	Región admitida | cadena | Expresión <cadena> | Restablecer valor	Región donde se deben implementar 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.
vpcConector	cadena | Expresión <cadena> | Restablecer valor	Conecte una función a un conector VPC específico.
vpcConnectorEgressConfiguración	Configuración de salida de Vpc | Restablecer valor	Configuración de salida para el conector VPC.

GlobalOptions.concurrencia

Número de solicitudes que una función puede atender a la vez.

Solo se puede aplicar a funciones que se ejecutan en Cloud Functions (segunda generación)). Un valor nulo restaura la simultaneidad predeterminada (80 cuando CPU > = 1, 1 en caso contrario). La simultaneidad no se puede establecer en ningún valor distinto de 1 si cpu es inferior a 1. El valor máximo de simultaneidad es 1000.

Firma:

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

GlobalOptions.cpu

Número fraccionario 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 (1.ª generación). Para volver a las cantidades de CPU utilizadas en gcloud o en Cloud Functions (1.ª generación), configúrelo 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.ingressConfiguración

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

Firma:

ingressSettings?: IngressSetting | ResetValue;

GlobalOptions.invocador

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

Firma:

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

Etiquetas GlobalOptions

Etiquetas de usuario para configurar en la función.

Firma:

labels?: Record<string, string>;

GlobalOptions.maxInstancias

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.minInstancias

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.omitir

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 lance 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;

GlobalOptions.región

Región donde se deben implementar las funciones.

Firma:

region?: SupportedRegion | string | Expression<string> | ResetValue;

GlobalOptions.secretos

Firma:

secrets?: (string | SecretParam)[];

GlobalOptions.servicioCuenta

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

Firma:

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

GlobalOptions.timeoutSegundos

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 1 segundo. El tiempo de espera máximo para una función depende del tipo de función: las funciones de manejo de eventos tienen un tiempo de espera máximo de 540 s (9 minutos). HTTPS y las funciones invocables tienen un tiempo de espera máximo de 36 s (1 hora). Las funciones de la cola de tareas tienen un tiempo de espera máximo de 1800 segundos (30 minutos).

Firma:

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

Conector GlobalOptions.vpc

Conecte una función a un conector VPC específico.

Firma:

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

GlobalOptions.vpcConnectorEgressSettings

Configuración de salida para el conector VPC.

Firma:

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;