FunctionBuilder class

Podpis:

export declare class FunctionBuilder

Zespoły

Zespół Modyfikatory Opis
(konstruktor)(opcje) Tworzy nową instancję klasy FunctionBuilder

Właściwości

Właściwość Modyfikatory Typ Opis
statystyki { zdarzenie: (analyticsEventType: ciąg) => analytics.AnalyticsEventBuilder;
auth { user: (userOptions?: auth.UserOptions) => auth.UserBuilder;
baza danych { instancja: (instance: string) => database.InstanceBuilder; ref: <Odwołanie rozszerza ciąg znaków>(ścieżka: odwołanie) => database.RefBuilder<Ref>;
firestore { document: <Ścieżka rozszerzenia ciągu>(ścieżka: Ścieżka) => firestore.DocumentBuilder<ścieżka>; przestrzeń nazw: (przestrzeń nazw: ciąg) => firestore.NamespaceBuilder; baza danych: (baza_danych: ciąg) => firestore.DatabaseBuilder;
https { onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions").HttpsFunction; onCall: (obsługa: (dane: dowolne, kontekst: https.CallableContext) => any | Promise<any>) => import("./cloud-functions").HttpsFunction & import("./cloud-functions").Gotowe<dowolne>;
pubsub { topic: (temat: ciąg znaków) => pubsub.TopicBuilder; harmonogram: (harmonogram: ciąg znaków) => pubsub.ScheduleBuilder;
remoteConfig { onUpdate: (obsługa: (wersja: remoteConfig.TemplateVersion, kontekst: EventContext) => PromiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>;
miejsce na dane { zasobnik: (zasobnik?: ciąg znaków) => storage.BucketBuilder; obiekt: () => storage.ObjectBuilder;
zadania {taskQueue: (options?: tasks.TaskQueueOptions) => tasks.TaskQueueBuilder;
testLab { testMatrix: () => testLab.TestMatrixBuilder;

Metody

Metoda Modyfikatory Opis
region(regions) Skonfiguruj regiony, w których funkcja jest wdrożona.
runWith(runtimeOptions), Skonfiguruj opcje środowiska wykonawczego dla funkcji.

Konstruktor funkcji.(konstruktor)

Tworzy nową instancję klasy FunctionBuilder

Podpis:

constructor(options: DeploymentOptions);

Parametry

Parametr Typ Opis
opcje DeploymentOptions (Opcje wdrażania)

Kreator funkcji.analytics

Podpis:

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

Kreator funkcji.auth

Podpis:

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

Kreator funkcji.baza_danych

Podpis:

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

Kreator funkcji.firestore

Podpis:

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

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

Kreator funkcji.pubsub

Podpis:

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

Budowanie_funkcji.zdalna_konfiguracja

Podpis:

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

Budowa funkcji.storage

Podpis:

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

Obiekt FunctionBuilder.tasks

Podpis:

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

Kreator funkcji.testLab

Podpis:

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

Narzędzie FunctionBuilder.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<(typeof SUPPORTED_REGIONS)[number] | ciąg znaków | Wyrażenie<ciąg> | ResetValue> Co najmniej 1 ciąg znaków regionu.

Zwroty:

Kreator funkcji

Przykład 1

features.region('us-east1')

Przykład 2

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

FunctionBuilder.runWith()

Skonfiguruj opcje środowiska wykonawczego dla funkcji.

Podpis:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Parametry

Parametr Typ Opis
Opcje środowiska wykonawczego RuntimeOptions (Opcje środowiska wykonawczego) Obiekt z polami opcjonalnymi: 1. memory: ilość pamięci, która ma zostać przydzielona do funkcji. Możliwe wartości to „128 MB”, „256 MB”, „512 MB”, „1 GB”, „2 GB”, „4 GB” i „8 GB”. 2. timeoutSeconds: czas oczekiwania funkcji w sekundach. Możliwe wartości to od 0 do 540. 3. failurePolicy: zasada niepowodzenia funkcji, przy czym wartość logiczna true oznacza podanie pustego obiektu ponowienia próby. 4. vpcConnector: identyfikator oprogramowania sprzęgającego VPC w tym samym projekcie i regionie 5. vpcConnectorEgressSettings: gdy skonfigurowana jest wartość vpcConnector, określ, który ruch wychodzący ma być wysyłany przez interfejs vpcConnector.Wartość nie może być pusta.

Zwroty:

Kreator funkcji