FunctionBuilder class

Unterschrift:

export declare class FunctionBuilder

Konstrukteure

Konstrukteur Modifikatoren Beschreibung
(Konstruktor)(Optionen) Konstruiert eine neue Instanz der FunctionBuilder -Klasse

Eigenschaften

Eigentum Modifikatoren Typ Beschreibung
Analytik { event: (analyticsEventType: string) => Analytics.AnalyticsEventBuilder ; }
Autor { user: (userOptions?: auth.UserOptions ) => auth.UserBuilder ; }
Datenbank { Instanz: (Instanz: Zeichenfolge) => Datenbank.InstanceBuilder ; ref: <Ref erweitert String>(Pfad: Ref) => Datenbank.RefBuilder <Ref>; }
Feuerladen { document: <Path erweitert String>(Pfad: Pfad) => firestore.DocumentBuilder <Pfad>; Namespace: (Namespace: String) => firestore.NamespaceBuilder ; Datenbank: (Datenbank: Zeichenfolge) => firestore.DatabaseBuilder ; }
https { onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions"). HttpsFunction ; onCall: (handler: (Daten: beliebig, Kontext: https.CallableContext ) => beliebig | Promise<any>) => import("./cloud-functions"). HttpsFunction & import("./cloud-functions"). Lauffähig <beliebig>; }
pubsub { topic: (topic: string) => pubsub.TopicBuilder ; Zeitplan: (Zeitplan: Zeichenfolge) => pubsub.ScheduleBuilder ; }
remoteConfig { onUpdate: (handler: (version: remoteConfig.TemplateVersion , Kontext: EventContext ) => PromiseLike<any> | any) => import("./cloud-functions"). CloudFunction < remoteConfig.TemplateVersion >; }
Lagerung { Bucket: (Bucket?: String) => storage.BucketBuilder ; Objekt: () => storage.ObjectBuilder ; }
Aufgaben { taskQueue: (Optionen?: task.TaskQueueOptions ) => task.TaskQueueBuilder ; }
testLab { testMatrix: () => testLab.TestMatrixBuilder ; }

Methoden

Methode Modifikatoren Beschreibung
Region(Regionen) Konfigurieren Sie die Regionen, in denen die Funktion bereitgestellt wird.
runWith(runtimeOptions) Konfigurieren Sie Laufzeitoptionen für die Funktion.

FunctionBuilder.(Konstruktor)

Konstruiert eine neue Instanz der FunctionBuilder -Klasse

Unterschrift:

constructor(options: DeploymentOptions);

Parameter

Parameter Typ Beschreibung
Optionen Bereitstellungsoptionen

FunctionBuilder.analytics

Unterschrift:

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

FunctionBuilder.auth

Unterschrift:

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

FunctionBuilder.database

Unterschrift:

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

FunctionBuilder.firestore

Unterschrift:

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

FunctionBuilder.https

Unterschrift:

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

Unterschrift:

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

FunctionBuilder.remoteConfig

Unterschrift:

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

FunctionBuilder.storage

Unterschrift:

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

FunctionBuilder.tasks

Unterschrift:

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

FunctionBuilder.testLab

Unterschrift:

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

FunctionBuilder.region()

Konfigurieren Sie die Regionen, in denen die Funktion bereitgestellt wird.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
Regionen Array<(Typ von SUPPORTED_REGIONS )[Anzahl] | Zeichenfolge | Ausdruck <string> | Wert zurücksetzen> Eine oder mehrere Regionszeichenfolgen.

Kehrt zurück:

FunctionBuilder

Beispiel 1

Funktionen.Region('us-east1')

Beispiel 2

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

FunctionBuilder.runWith()

Konfigurieren Sie Laufzeitoptionen für die Funktion.

Unterschrift:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Parameter

Parameter Typ Beschreibung
Laufzeitoptionen Laufzeitoptionen Objekt mit optionalen Feldern: 1. memory : Speichermenge, die der Funktion zugewiesen werden soll. Mögliche Werte sind: „128 MB“, „256 MB“, „512 MB“, „1 GB“, „2 GB“, „4 GB“ und „8 GB“. . 2. timeoutSeconds : Timeout für die Funktion in Sekunden, mögliche Werte sind 0 bis 540. 3. failurePolicy : Fehlerrichtlinie der Funktion, wobei boolean true der Bereitstellung eines leeren Wiederholungsobjekts entspricht. 4. vpcConnector : ID eines VPC-Connectors im selben Projekt und in der gleichen Region. 5. vpcConnectorEgressSettings : Wenn ein vpcConnector festgelegt ist, steuern Sie, welcher ausgehende Datenverkehr über den vpcConnector gesendet wird. Der Wert darf nicht null sein.

Kehrt zurück:

FunctionBuilder