FunctionBuilder class

Firma:

export declare class FunctionBuilder

Constructores

Constructor Teclas modificadoras Descripción
(constructor)(opciones) Construye una instancia nueva de la clase FunctionBuilder.

Propiedades

Propiedad Teclas modificadoras Tipo Descripción
Analytics { event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder; }.
autenticación { usuario: (userOptions?: auth.UserOptions) => auth.UserBuilder: }.
base de datos { instance: (instance: string) => database.InstanceBuilder; ref: <La referencia extiende la cadena>(ruta: la referencia) => database.RefBuilder<Ref>; }.
Firestore { documento: <La ruta extiende la cadena>(ruta: Ruta) => firestore.DocumentBuilder<Ruta>: espacio de nombres: (espacio de nombres: string) => firestore.NamespaceBuilder: base de datos: (base de datos: string) => firestore.DatabaseBuilder; }.
https { onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions").HttpsFunction; onCall: (handler: (data: any, context: https.CallableContext) => any | Promise<any>) => import("./cloud-functions").HttpsFunction y import("./cloud-functions").Runnable<any>; }.
pubsub { tema: (tema: cadena) => pubsub.TopicBuilder; programa: (programa: string) => pubsub.ScheduleBuilder; }.
remoteConfig { onUpdate: (handler: (version: remoteConfig.TemplateVersion, contexto: EventContext) => PromiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>; }.
almacenamiento { bucket: (bucket?: string) => storage.BucketBuilder: objeto: () => storage.ObjectBuilder; }.
tareas { taskQueue: (opciones?: tasks.TaskQueueOptions) => tasks.TaskQueueBuilder; }.
testLab { Matriz de prueba: () => testLab.TestMatrixBuilder; }.

Métodos

Método Teclas modificadoras Descripción
region(regiones) Configurar las regiones en las que se implementa la función
runWith(runtimeOptions) Configura las opciones del entorno de ejecución para la función.

FunctionBuilder.(constructor)

Construye una instancia nueva de la clase FunctionBuilder.

Firma:

constructor(options: DeploymentOptions);

Parámetros

Parámetro Tipo Descripción
opciones Opciones de implementación

FunctionBuilder.analytics

Firma:

get analytics(): {
        event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder;
    };

FunctionBuilder.auth

Firma:

get auth(): {
        user: (userOptions?: auth.UserOptions) => auth.UserBuilder;
    };

FunctionBuilder.database

Firma:

get database(): {
        instance: (instance: string) => database.InstanceBuilder;
        ref: <Ref extends string>(path: Ref) => database.RefBuilder<Ref>;
    };

FunctionBuilder.firestore

Firma:

get firestore(): {
        document: <Path extends string>(path: Path) => firestore.DocumentBuilder<Path>;
        namespace: (namespace: string) => firestore.NamespaceBuilder;
        database: (database: string) => firestore.DatabaseBuilder;
    };

FunctionBuilder.https

Firma:

get https(): {
        onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions").HttpsFunction;
        onCall: (handler: (data: any, context: https.CallableContext) => any | Promise<any>) => import("./cloud-functions").HttpsFunction & import("./cloud-functions").Runnable<any>;
    };

FunctionBuilder.pubsub

Firma:

get pubsub(): {
        topic: (topic: string) => pubsub.TopicBuilder;
        schedule: (schedule: string) => pubsub.ScheduleBuilder;
    };

FunctionBuilder.remoteConfig

Firma:

get remoteConfig(): {
        onUpdate: (handler: (version: remoteConfig.TemplateVersion, context: EventContext) => PromiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>;
    };

FunctionBuilder.storage

Firma:

get storage(): {
        bucket: (bucket?: string) => storage.BucketBuilder;
        object: () => storage.ObjectBuilder;
    };

FunctionBuilder.tasks

Firma:

get tasks(): {
        taskQueue: (options?: tasks.TaskQueueOptions) => tasks.TaskQueueBuilder;
    };

FunctionBuilder.testLab

Firma:

get testLab(): {
        testMatrix: () => testLab.TestMatrixBuilder;
    };

FunctionBuilder.region()

Configurar las regiones en las que se implementa la función

Firma:

region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;

Parámetros

Parámetro Tipo Descripción
regiones Arreglo<(tipo de SUPPORTED_REGIONS)[número] | cadena | Expresión<string> | RestablecerValor> Una o más cadenas de región.

Muestra:

FunctionBuilder

Ejemplo 1

functions.region('us-east1')

Ejemplo 2

funciones.region('us-east1', 'us-central1')

FunctionBuilder.runWith()

Configura las opciones del entorno de ejecución para la función.

Firma:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Parámetros

Parámetro Tipo Descripción
Opciones de entorno de ejecución Opciones del tiempo de ejecución Objeto con campos opcionales: 1. memory: La cantidad de memoria que se asignará a la función. Los valores posibles son “128 MB”, “256 MB”, “512 MB”, “1 GB”, “2 GB”, “4 GB” y “8 GB”. 2. timeoutSeconds: Se agota el tiempo de espera de la función en segundos. Los valores posibles son de 0 a 540. 3. failurePolicy: Es la política de fallas de la función, con el booleano true que equivale a proporcionar un objeto de reintento vacío. 4. vpcConnector: Es el ID de un conector de VPC en el mismo proyecto y la misma región 5. vpcConnectorEgressSettings: Cuando se establece un vpcConnector, controla qué tráfico de salida se envía a través de vpcConnector. El valor no debe ser nulo.

Muestra:

FunctionBuilder