FunctionBuilder class

Firma:

export declare class FunctionBuilder

Constructores

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

Propiedades

Propiedad Modificadores Tipo Descripción
analítica { evento: (analyticsEventType: cadena) => análisis.AnalyticsEventBuilder ; }
autenticación { usuario: (opciones de usuario?: auth.Opciones de usuario ) => autenticación.UserBuilder ; }
base de datos { instancia: (instancia: cadena) => base de datos.InstanceBuilder ; ref: <Ref extiende cadena>(ruta: Ref) => base de datos.RefBuilder <Referencia>; }
tienda de fuego { documento: <La ruta extiende la cadena>(ruta: Ruta) => firestore.DocumentBuilder <Ruta>; espacio de nombres: (espacio de nombres: cadena) => firestore.NamespaceBuilder ; base de datos: (base de datos: cadena) => firestore.DatabaseBuilder ; }
https { onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions"). Función Https ; onCall: (controlador: (datos: cualquiera, contexto: https.CallableContext ) => cualquiera | Promesa<cualquier>) => import("./cloud-functions"). HttpsFunction e importación("./funciones en la nube"). Ejecutable <cualquiera>; }
pubsub { tema: (tema: cadena) => pubsub.TopicBuilder ; horario: (horario: cadena) => pubsub.ScheduleBuilder ; }
configuración remota { onUpdate: (controlador: (versión: remoteConfig.TemplateVersion , contexto: EventContext ) => PromesaComo<cualquiera> | cualquiera) => importar("./funciones-nube"). Función de nube < configuración remota.Versión de plantilla >; }
almacenamiento { depósito: (¿depósito?: cadena) => almacenamiento.BucketBuilder ; objeto: () => almacenamiento.ObjectBuilder ; }
tareas { taskQueue: (¿opciones?: tareas.TaskQueueOptions ) => tareas.TaskQueueBuilder ; }
laboratorio de pruebas { testMatrix: () => testLab.TestMatrixBuilder ; }

Métodos

Método Modificadores Descripción
región(regiones) Configure las regiones en las que se implementa la función.
ejecutar con (opciones de tiempo de ejecución) Configure las opciones de tiempo de ejecución para la función.

FunctionBuilder.(constructor)

Construye una nueva instancia de la clase FunctionBuilder

Firma:

constructor(options: DeploymentOptions);

Parámetros

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

FunctionBuilder.análisis

Firma:

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

FunctionBuilder.auth

Firma:

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

FunctionBuilder.base de datos

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

Generador de funciones.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.almacenamiento

Firma:

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

FuncionesBuilder.tareas

Firma:

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

FunctionBuilder.testLab

Firma:

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

FunctionBuilder.región()

Configure 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 Matriz<(tipo de SUPPORTED_REGIONS )[número] | cadena | Expresión <cadena> | Restablecer valor> Una o más cadenas de región.

Devoluciones:

Generador de funciones

Ejemplo 1

funciones.region('us-east1')

Ejemplo 2

funciones.region('nosotros-este1', 'nosotros-central1')

FunctionBuilder.runWith()

Configure las opciones de tiempo de ejecución para la función.

Firma:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Parámetros

Parámetro Tipo Descripción
Opciones de tiempo de ejecución Opciones de tiempo de ejecución Objeto con campos opcionales: 1. memory : cantidad de memoria para 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 : tiempo de espera para la función en segundos, los valores posibles son de 0 a 540. 3. failurePolicy : política de falla de la función, siendo el valor booleano true equivalente a proporcionar un objeto de reintento vacío. 4. vpcConnector : ID de un conector VPC en el mismo proyecto y región. 5. vpcConnectorEgressSettings : cuando se configura un vpcConnector , controla qué tráfico de salida se envía a través de vpcConnector . El valor no debe ser nulo.

Devoluciones:

Generador de funciones