GlobalOptions son opciones que se pueden establecer en todo un proyecto. Estas opciones son comunes a HTTPS y a las funciones de control de eventos.
Firma:
export interface GlobalOptions
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| simultaneidad | número | Expresión<número> | RestablecerValor | Cantidad de solicitudes que puede entregar una función a la vez. |
| CPU | número | “gcf_gen1” | Cantidad fraccionaria de CPU para asignar a una función. |
| aplicar la verificación de aplicaciones | booleano | Determina si se aplica la Verificación de aplicaciones de Firebase. La configuración predeterminada es "false". |
| ingressSettings | IngressSetting | 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 | La cantidad máxima de instancias que se pueden ejecutar en paralelo. |
| memoria | MemoryOption | Expresión<número> | RestablecerValor | Cantidad de memoria para asignar a una función. |
| instanciasmin | número | Expresión<número> | RestablecerValor | Cantidad mínima de instancias reales que se ejecutarán en un momento determinado. |
| omitir | booleano | Expresión<booleano> | Si es verdadero, no implementes ni emules esta función. |
| 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". |
| region | SupportedRegion | cadena | Expresión<string> | RestablecerValor | La región en la que se deben implementar las funciones. |
| secretos | (cadena | SecretParam)[] | |
| serviceAccount | 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. Las funciones HTTPS pueden especificar un tiempo de espera mayor. |
| vpcConnector | cadena | Expresión<string> | RestablecerValor | Conecta una función a un conector de VPC especificado. |
| vpcConnectorEgressSettings | VpcEgressSetting | RestablecerValor | Configuración de salida para el conector de VPC. |
GlobalOptions.concurrency
Cantidad de solicitudes que puede entregar una función a la vez.
Solo se puede aplicar a las funciones que se ejecutan en Cloud Functions (2a gen.)). Un valor nulo restablece la simultaneidad predeterminada (80 cuando CPU >= 1, 1 en caso contrario). No se puede establecer la simultaneidad en ningún valor que no sea 1 si cpu es menor que 1. El valor máximo para la simultaneidad es 1,000.
Firma:
concurrency?: number | Expression<number> | ResetValue;
GlobalOptions.cpu
Cantidad fraccionaria de CPU para asignar a una función.
El valor predeterminado es 1 para las 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 de gcloud y es diferente del importe fijo asignado en Cloud Functions (1a gen.). Para revertir a las cantidades de CPU usadas en gcloud o en Cloud Functions (1a gen.), establece esto en el valor “gcf_gen1”
Firma:
cpu?: number | "gcf_gen1";
GlobalOptions.enforceAppCheck.
Determina si se aplica la Verificación de aplicaciones de Firebase. La configuración predeterminada es "false".
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 establecen event.app en undefined.
Firma:
enforceAppCheck?: boolean;
GlobalOptions.ingressSettings
Son parámetros de configuración de entrada que controlan desde dónde se puede llamar a esta función.
Firma:
ingressSettings?: IngressSetting | ResetValue;
GlobalOptions.Invoker
Invocador para configurar el control de acceso en las funciones HTTPS.
Firma:
invoker?: "public" | "private" | string | string[];
GlobalOptions.labels
Son las etiquetas de usuario que se deben configurar en la función.
Firma:
labels?: Record<string, string>;
GlobalOptions.maxInstances
La cantidad máxima de instancias que se pueden ejecutar en paralelo.
Firma:
maxInstances?: number | Expression<number> | ResetValue;
GlobalOptions.memory
Cantidad de memoria para asignar a una función.
Firma:
memory?: MemoryOption | Expression<number> | ResetValue;
GlobalOptions.minInstances
Cantidad mínima de instancias reales que se ejecutarán en un momento determinado.
Las instancias se facturan por la asignación de memoria y por el 10% de la asignación de CPU mientras estén inactivas.
Firma:
minInstances?: number | Expression<number> | ResetValue;
GlobalOptions.omit.
Si es verdadero, no implementes ni emules esta función.
Firma:
omit?: boolean | Expression<boolean>;
GlobalOptions.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 una plataforma subyacente que aún no está disponible en el SDK de Firebase para Cloud Functions, te recomendamos establecer preserveExternalChanges en true. De lo contrario, cuando Google lanza una nueva versión del SDK compatible con la configuración que falta, es posible que la configuración manual de la función se borre sin darte cuenta.
Firma:
preserveExternalChanges?: boolean;
GlobalOptions.region
La región en la que se deben implementar las funciones.
Firma:
region?: SupportedRegion | string | Expression<string> | ResetValue;
GlobalOptions.secrets
Firma:
secrets?: (string | SecretParam)[];
GlobalOptions.serviceAccount.
Cuenta de servicio específica con la que se ejecutará la función.
Firma:
serviceAccount?: string | Expression<string> | ResetValue;
GlobalOptions.timeoutSeconds
Es el tiempo de espera de 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 2a gen. es de 1 s. El tiempo de espera máximo de una función depende del tipo de función: las funciones de control de eventos tienen un tiempo de espera máximo de 540 s (9 minutos). Las funciones HTTPS y que admiten llamadas tienen un tiempo de espera máximo de 36,00 s (1 hora). Las funciones de lista de tareas en cola tienen un tiempo de espera máximo de 1,800 s (30 minutos).
Firma:
timeoutSeconds?: number | Expression<number> | ResetValue;
GlobalOptions.vpcConnector
Conecta 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;