https.HttpsOptions interface

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

Firma:

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

Extensiones: Omite<GlobalOptions, "region">

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.
cors cadena | booleano | Expresión regular | Arreglo<string | Exp.reg> Si es verdadero, permite CORS en solicitudes a esta función. Si se trata de string o RegExp, permite solicitudes de dominios que coinciden con el valor proporcionado. Si se trata de un Array, permite solicitudes de dominios que coincidan con al menos una entrada del array. El valor predeterminado es verdadero para https.CallableFunction y falso de lo contrario.
CPU número | “gcf_gen1” Cantidad fraccionaria de CPU para asignar a una función.
ingressSettings options.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 ejecutarán en paralelo.
memoria options.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.
region SupportedRegion | cadena | Arreglo<SupportedRegion | cadena> | Expresión<string> | RestablecerValor Las funciones de HTTP pueden anular opciones globales y especificar varias regiones en las que realizar la implementación.
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 la Cloud Function al conector de VPC especificado.
vpcConnectorEgressSettings options.VpcEgressSetting | RestablecerValor Configuración de salida para el conector de VPC.

https.HttpsOptions.concurrency

Cantidad de solicitudes que puede entregar una función a la vez.

Solo se puede aplicar a funciones que se ejecutan en Cloud Functions v2. 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;

https://www.HttpsOptions.cors

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

Firma:

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

https.HttpsOptions.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 la generación 1 de Google Cloud Functions. Para revertir a las cantidades de CPU usadas en gcloud o en la generación 1 de Cloud Functions, establece esto en el valor “gcf_gen1”

Firma:

cpu?: number | "gcf_gen1";

https.HttpsOptions.ingressSettings

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

Firma:

ingressSettings?: options.IngressSetting | ResetValue;

https.HttpsOptions.Invoker

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

Firma:

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

https.HttpsOptions.labels

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

Firma:

labels?: Record<string, string>;

https.HttpsOptions.maxInstances

La cantidad máxima de instancias que se ejecutarán en paralelo.

Firma:

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

https.HttpsOptions.memory

Cantidad de memoria para asignar a una función.

Firma:

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

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

https://www.HttpsOptions.omit.

Si es verdadero, no implementes ni emules esta función.

Firma:

omit?: boolean | Expression<boolean>;

https.HttpsOptions.region

Las funciones de HTTP pueden anular opciones globales y especificar varias regiones en las que realizar la implementación.

Firma:

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

https.HttpsOptions.secrets

Firma:

secrets?: (string | SecretParam)[];

https.HttpsOptions.serviceAccount

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

Firma:

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

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

https.HttpsOptions.vpcConnector

Conecta la Cloud Function 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;