FunctionBuilder class

Signature:

export declare class FunctionBuilder

Constructeurs

Constructeur Modificateurs Description
(constructeur)(options) Construit une nouvelle instance de la classe FunctionBuilder

Propriétés

Propriété Modificateurs Taper Description
analytique { événement : (analyticsEventType : chaîne) => Analytics.AnalyticsEventBuilder ; }
authentification {utilisateur : (Optionsutilisateur ? : auth.Optionsutilisateur ) => auth.UserBuilder ; }
base de données { instance : (instance : chaîne) => base de données.InstanceBuilder ; ref: <Ref étend la chaîne> (chemin : Ref) => base de données.RefBuilder <Réf> ; }
magasin de feu { document : <Chemin étend la chaîne>(chemin : Chemin) => firestore.DocumentBuilder <Chemin> ; espace de noms : (espace de noms : chaîne) => firestore.NamespaceBuilder ; base de données : (base de données : chaîne) => firestore.DatabaseBuilder ; }
https { onRequest : (handler : (req : https.Request, resp : express.Response) => void | Promise<void>) => import("./cloud-functions"). Fonction HTTPS ; onCall : (gestionnaire : (données : toutes, contexte : https.CallableContext ) => n'importe quel | Promesse<any>) => import("./cloud-functions"). HttpsFunction & import("./cloud-functions"). Exécutable <n'importe lequel> ; }
pubsub { sujet : (sujet : chaîne) => pubsub.TopicBuilder ; planning : (calendrier : chaîne) => pubsub.ScheduleBuilder ; }
configuration à distance { onUpdate : (gestionnaire : (version : remoteConfig.TemplateVersion , contexte : EventContext ) => PromiseLike<any> | any) => import("./cloud-functions"). Fonction Cloud < remoteConfig.TemplateVersion > ; }
stockage { bucket : (bucket ? : string) => storage.BucketBuilder ; objet : () => stockage.ObjectBuilder ; }
Tâches { taskQueue : (options ? : tâches.TaskQueueOptions ) => tâches.TaskQueueBuilder ; }
laboratoire de test { testMatrix : () => testLab.TestMatrixBuilder ; }

Méthodes

Méthode Modificateurs Description
région(s) régions Configurez les régions dans lesquelles la fonction est déployée.
exécuterAvec(options d'exécution) Configurez les options d'exécution pour la fonction.

FunctionBuilder. (constructeur)

Construit une nouvelle instance de la classe FunctionBuilder

Signature:

constructor(options: DeploymentOptions);

Paramètres

Paramètre Taper Description
choix Options de déploiement

FunctionBuilder.analytics

Signature:

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

FunctionBuilder.auth

Signature:

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

FunctionBuilder.base de données

Signature:

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

FunctionBuilder.firestore

Signature:

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

FunctionBuilder.https

Signature:

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

Signature:

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

FunctionBuilder.remoteConfig

Signature:

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

FunctionBuilder.stockage

Signature:

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

FunctionBuilder.tâches

Signature:

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

FunctionBuilder.testLab

Signature:

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

FunctionBuilder.region()

Configurez les régions dans lesquelles la fonction est déployée.

Signature:

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

Paramètres

Paramètre Taper Description
Régions Tableau<(type de SUPPORTED_REGIONS )[numéro] | chaîne | Expression <chaîne> | Réinitialiser la valeur> Une ou plusieurs chaînes de région.

Retour:

Générateur de fonctions

Exemple 1

fonctions.region('us-east1')

Exemple 2

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

FunctionBuilder.runWith()

Configurez les options d'exécution pour la fonction.

Signature:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Paramètres

Paramètre Taper Description
Options d'exécution Options d'exécution Objet avec champs optionnels : 1. memory : quantité de mémoire à allouer à la fonction, les valeurs possibles sont : '128Mo', '256Mo', '512Mo', '1Go', '2Go', '4Go' et '8Go' . 2. timeoutSeconds : timeout de la fonction en secondes, les valeurs possibles sont 0 à 540. 3. failurePolicy : politique d'échec de la fonction, le booléen true étant équivalent à fournir un objet de nouvelle tentative vide. 4. vpcConnector : identifiant d'un connecteur VPC dans le même projet et la même région 5. vpcConnectorEgressSettings : lorsqu'un vpcConnector est défini, contrôlez quel trafic de sortie est envoyé via vpcConnector . La valeur ne doit pas être nulle.

Retour:

Générateur de fonctions