https.HttpsOptions interface

Opciones que se pueden configurar en una función onRequest HTTPS.

Firma:

export interface HttpsOptions extends Omit<GlobalOptions, "region"> 

Extiende: Omitir< GlobalOptions , "región">

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.
corazones cadena | booleano | RegExp | matriz<cadena | RegExp> Si es verdadero, permite CORS en solicitudes a esta función. Si se trata de una string o RegExp , permite solicitudes de dominios que coincidan con el valor proporcionado. Si se trata de una Array , permite solicitudes de dominios que coincidan con al menos una entrada de la matriz. El valor predeterminado es verdadero para https.CallableFunction y falso en caso contrario.
UPC número | "gcf_gen1" Número fraccional de CPU para asignar a una función.
configuración de ingreso opciones.IngressSetting | 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 control de acceso en 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 ejecutarán en paralelo.
memoria opciones.MemoryOption | 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.
región Región admitida | cadena | Array< Región admitida | cadena> | Expresión <cadena> | Restablecer valor Las funciones HTTP pueden anular las opciones globales y pueden especificar múltiples regiones para implementar.
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 la función de nube al conector de VPC especificado.
vpcConnectorEgressSettings opciones.VpcEgressSetting | Restablecer valor Configuración de salida para el conector de VPC.

https.HttpsOptions.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 v2. 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;

https.HttpsOptions.cors

Si es verdadero, permite CORS en solicitudes a esta función. Si se trata de una string o RegExp , permite solicitudes de dominios que coincidan con el valor proporcionado. Si esto es una Array , permite solicitudes de dominios que coincidan con al menos una entrada de la matriz. El valor predeterminado es verdadero para https.CallableFunction y falso en caso contrario.

Firma:

cors?: string | boolean | RegExp | Array<string | RegExp>;

https.HttpsOptions.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 Google Cloud Functions generación 1. Para volver a las cantidades de CPU utilizadas en gcloud o en Cloud Functions generación 1, establezca esto en el valor "gcf_gen1"

Firma:

cpu?: number | "gcf_gen1";

https.HttpsOptions.ingressSettings

Ajustes de entrada que controlan desde dónde se puede llamar a esta función.

Firma:

ingressSettings?: options.IngressSetting | ResetValue;

https.HttpsOptions.invoker

Invocador para establecer control de acceso en funciones https.

Firma:

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

https.HttpsOptions.etiquetas

Etiquetas de usuario para establecer en la función.

Firma:

labels?: Record<string, string>;

https.HttpsOptions.maxInstances

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

Firma:

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

https.HttpsOptions.memoria

Cantidad de memoria para asignar a una función.

Firma:

memory?: options.MemoryOption | Expression<number> | ResetValue;

https.HttpsOptions.minInstancias

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

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;

https.HttpsOptions.omit

Si es verdadero, no implemente ni emule esta función.

Firma:

omit?: boolean | Expression<boolean>;

https.HttpsOptions.región

Las funciones HTTP pueden anular las opciones globales y pueden especificar múltiples regiones para implementar.

Firma:

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

https.HttpsOptions.secretos

Firma:

secrets?: (string | SecretParam)[];

https.HttpsOptions.serviceAccount

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

Firma:

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

https.HttpsOptions.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 gen 2 es 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;

https.HttpsOptions.vpcConnector

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

Firma:

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

https.HttpsOptions.vpcConnectorEgressSettings

Configuración de salida para el conector de VPC.

Firma:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;