FunctionBuilder class

Podpis:

export declare class FunctionBuilder 

Konstruktorzy

Konstruktor Modyfikatory Opis
(konstruktor)(opcje) Konstruuje nową instancję klasy FunctionBuilder

Nieruchomości

Nieruchomość Modyfikatory Typ Opis
analityka { zdarzenie: (analyticsEventType: string) => analytics.AnalyticsEventBuilder ; }
autoryzacja { użytkownik: (userOptions?: auth.UserOptions ) => auth.UserBuilder ; }
Baza danych { instancja: (instancja: string) => baza danych.InstanceBuilder ; ref: <Ref rozszerza ciąg>(ścieżka: Ref) => baza danych.RefBuilder <Odniesienie>; }
sklep z ogniem { dokument: <Ścieżka rozszerza ciąg> (ścieżka: Ścieżka) => firestore.DocumentBuilder <Ścieżka>; namespace: (namespace: string) => firestore.NamespaceBuilder ; baza danych: (baza danych: string) => firestore.DatabaseBuilder ; }
https { onRequest: (obsługa: (req: https.Request, resp: express.Response) => void | Promise<void>) => import(./cloud-functions"). Funkcja Https ; onCall: (obsługa: (dane: dowolne, kontekst: https.CallableContext ) => dowolny | Obietnica<any>) => import("./cloud-functions"). Funkcja Https i import("./funkcje-chmury"). Możliwość uruchomienia <dowolny>; }
pubsub { topic: (temat: string) => pubsub.TopicBuilder ; harmonogram: (harmonogram: string) => pubsub.ScheduleBuilder ; }
zdalna konfiguracja { onUpdate: (obsługa: (wersja: RemoteConfig.TemplateVersion , kontekst: EventContext ) => ObietnicaLike<dowolny> | any) => import("./cloud-functions"). Funkcja chmury < RemoteConfig.TemplateVersion >; }
składowanie { wiadro: (wiadro?: ciąg) => przechowywanie.BucketBuilder ; obiekt: () => przechowywanie.ObjectBuilder ; }
zadania { kolejka zadań: (opcje?: zadania.TaskQueueOptions ) => zadania.TaskQueueBuilder ; }
laboratorium testowe { testMatrix: () => testLab.TestMatrixBuilder ; }

Metody

metoda Modyfikatory Opis
region(regiony) Skonfiguruj regiony, w których funkcja jest wdrożona.
runWith (opcje czasu wykonania) Skonfiguruj opcje środowiska wykonawczego dla tej funkcji.

Konstruktor funkcji.(konstruktor)

Konstruuje nową instancję klasy FunctionBuilder

Podpis:

constructor(options: DeploymentOptions);

Parametry

Parametr Typ Opis
opcje Opcje wdrożenia

FunctionBuilder.analytics

Podpis:

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

FunctionBuilder.auth

Podpis:

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

Baza danych FunctionBuilder

Podpis:

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

FunctionBuilder.firestore

Podpis:

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

Konstruktor funkcji.https

Podpis:

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

Podpis:

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

FunctionBuilder.remoteConfig

Podpis:

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

Funkcja Builder.storage

Podpis:

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

FunctionBuilder.zadania

Podpis:

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

FunctionBuilder.testLab

Podpis:

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

Konstruktor funkcji.region()

Skonfiguruj regiony, w których funkcja jest wdrożona.

Podpis:

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

Parametry

Parametr Typ Opis
regiony Tablica<(typ SUPPORTED_REGIONS )[liczba] | ciąg | Wyrażenie <ciąg> | Zresetuj wartość> Co najmniej jeden ciąg regionu.

Zwroty:

Konstruktor funkcji

Przykład 1

funkcje.region('us-wschód1')

Przykład 2

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

Konstruktor funkcji.runWith()

Skonfiguruj opcje środowiska wykonawczego dla tej funkcji.

Podpis:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Parametry

Parametr Typ Opis
Opcje czasu wykonania Opcje czasu wykonania Obiekt z opcjonalnymi polami: 1. memory : ilość pamięci do przydzielenia dla funkcji, możliwe wartości to: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB' i '8GB' . 2. timeoutSeconds : limit czasu funkcji w sekundach, możliwe wartości to 0 do 540. 3. failurePolicy : polityka dotycząca błędów funkcji, gdzie wartość logiczna true jest równoznaczna z udostępnieniem pustego obiektu ponownej próby. 4. vpcConnector : identyfikator łącznika VPC w tym samym projekcie i regionie 5. vpcConnectorEgressSettings : po ustawieniu vpcConnector kontroluj, jaki ruch wychodzący jest wysyłany przez vpcConnector . Wartość nie może mieć wartości null.

Zwroty:

Konstruktor funkcji