FunctionBuilder class

İmza:

export declare class FunctionBuilder

Markalar

Marka Değiştiriciler Açıklama
(kurucu)(seçenekler) FunctionBuilder sınıfının yeni bir örneğini oluşturur

Özellikler

Özellik Değiştiriciler Tür Açıklama
analiz { event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder; }
kimlik doğrulama { user: (userOptions?: auth.UserOptions) => auth.UserBuilder; }
veritabanı { ornek: (ornek: dize) => database.InstanceBuilder; ref: <Ref genişletme dizesi>(path: Ref) => database.RefBuilder<Ref>; }
firestore { document: <Yol uzatma dizesi>(yol: Yol) => firestore.DocumentBuilder<Path>; ad alanı: (ad alanı: dize) => firestore.NamespaceBuilder; veritabanı: (veritabanı: dize) => firestore.DatabaseBuilder; }
https { onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions").HttpsFunction; onCall: (handler: (veri: herhangi, bağlam: https.CallableContext) => herhangi bir | Promise<any>) => import("./cloud-functions").HttpsFunction & import("./cloud-functions").Çalıştırılabilir<any>; }
pubsub { topic: (topic: string) => pubsub.TopicBuilder; plan: (planlama: dize) => pubsub.ScheduleBuilder; }
remoteConfig { onUpdate: (handler: (sürüm: remoteConfig.TemplateVersion, içerik: EventContext) => PromiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>; }
depolama alanı { paket: (paket?: dize) => storage.BucketBuilder; nesne: () => storage.ObjectBuilder; }
görevler {taskQueue: (options?: tasks.TaskQueueOptions) => tasks.TaskQueueBuilder; }
testLab { testMatrix: () => testLab.TestMatrixBuilder; }

Yöntemler

Yöntem Değiştiriciler Açıklama
region(bölge) İşlevin dağıtıldığı bölgeleri yapılandırın.
runWith(runtimeOptions) İşlev için çalışma zamanı seçeneklerini yapılandırın.

İşlevOluşturucu.(kurucu)

FunctionBuilder sınıfının yeni bir örneğini oluşturur

İmza:

constructor(options: DeploymentOptions);

Parametreler

Parametre Tür Açıklama
seçenekler DeploymentOptions

İşlev Oluşturucu.analiz

İmza:

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

İşlev Oluşturucu.auth

İmza:

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

İşlevOluşturucu.veritabanı

İmza:

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

İşlevOluşturucu.firestore

İmza:

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

İşlev Oluşturucu.https

İmza:

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

İşlevOluşturucu.pubsub

İmza:

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

FunctionBuilder.remoteConfig

İmza:

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

İşlevOluşturucu.depolama

İmza:

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

İşlevOluşturucu.görevler

İmza:

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

İşlevOluşturucu.testLab

İmza:

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

İşlevOluşturucu.bölge()

İşlevin dağıtıldığı bölgeleri yapılandırın.

İmza:

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

Parametreler

Parametre Tür Açıklama
bölgeler Dizi<(typeof SUPPORTED_REGIONS)[number] | dize | İfade<string> | Değeri Sıfırla> Bir veya daha fazla bölge dizesi.

Şunu döndürür:

İşlev Oluşturucu

1. örnek

Functions.region('us-east1')

2. örnek

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

İşlevOluşturucu.runWith()

İşlev için çalışma zamanı seçeneklerini yapılandırın.

İmza:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Parametreler

Parametre Tür Açıklama
çalışma zamanıSeçenekleri Çalışma Zamanı Seçenekleri İsteğe bağlı alanları olan nesne: 1. memory: İşleve ayrılacak bellek miktarı; olası değerler şunlardır: "128 MB", "256 MB", "512 MB", "1 GB", "2 GB", "4 GB" ve "8 GB". 2. timeoutSeconds: İşlev için saniye cinsinden zaman aşımı, olası değerler 0 ile 540 arasındadır. 3. failurePolicy: İşlevin hata politikası; true boole değeri, boş bir yeniden deneme nesnesi sağlamaya eşdeğerdir. 4. vpcConnector: Aynı proje ve 5. bölgedeki bir VPC bağlayıcısının kimliği. vpcConnectorEgressSettings: vpcConnector ayarlandığında vpcConnector üzerinden hangi çıkış trafiğinin gönderileceğini kontrol edin.Değer null olmamalıdır.

Şunu döndürür:

İşlev Oluşturucu