FunctionBuilder class

İmza:

export declare class FunctionBuilder

İnşaatçılar

Oluşturucu Değiştiriciler Tanım
(yapıcı)(seçenekler) FunctionBuilder sınıfının yeni bir örneğini oluşturur

Özellikler

Mülk Değiştiriciler Tip Tanım
analitik { event: (analyticsEventType: string) => analitik.AnalyticsEventBuilder ; }
yetki { kullanıcı: (userOptions?: auth.UserOptions ) => auth.UserBuilder ; }
veri tabanı { örnek: (örnek: string) => veritabanı.InstanceBuilder ; ref: <Ref dizeyi genişletir>(yol: Ref) => veritabanı.RefBuilder <Ref>; }
itfaiye deposu { document: <Path extends string>(path: Path) => firestore.DocumentBuilder <Yol>; ad alanı: (ad alanı: string) => firestore.NamespaceBuilder ; veritabanı: (veritabanı: string) => firestore.DatabaseBuilder ; }
https { onRequest: (işleyici: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions"). Httpsİşlevi ; onCall: (işleyici: (veri: herhangi biri, bağlam: https.CallableContext ) => herhangi biri | Promise<any>) => import("./cloud-functions"). HttpsFunction & import("./cloud-functions"). Çalıştırılabilir <herhangi biri>; }
yayınevi { konu: (konu: string) => pubsub.TopicBuilder ; zamanlama: (schedule: string) => pubsub.ScheduleBuilder ; }
RemoteConfig { onUpdate: (işleyici: (sürüm: RemoteConfig.TemplateVersion) , bağlam: Olay Bağlamı ) => PromiseLike<herhangi biri> | herhangi biri) => import("./cloud-functions"). BulutFunction < RemoteConfig.TemplateVersion >; }
depolamak { kova: (kova?: string) => depolama.BucketBuilder ; nesne: () => depolama.ObjectBuilder ; }
görevler { görevKuyruğu: (seçenekler?: görevler.GörevKuyruğuSeçenekleri ) => görevler.TaskQueueBuilder ; }
testLab { testMatrix: () => testLab.TestMatrixBuilder ; }

Yöntemler

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

FunctionBuilder.(yapıcı)

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

İmza:

constructor(options: DeploymentOptions);

Parametreler

Parametre Tip Tanım
seçenekler DağıtımSeçenekleri

FunctionBuilder.analytics

İmza:

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

FunctionBuilder.auth

İmza:

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

FunctionBuilder.veritabanı

İmza:

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

FunctionBuilder.firestore

İmza:

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

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

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

FunctionBuilder.storage

İmza:

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

FunctionBuilder.tasks

İmza:

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

FunctionBuilder.testLab

İmza:

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

FunctionBuilder.region()

İş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 Tip Tanım
bölgeler Dizi<(typeof SUPPORTED_REGIONS )[sayı] | dize | İfade <string> | Değeri Sıfırla> Bir veya daha fazla bölge dizesi.

İadeler:

Fonksiyon Oluşturucu

örnek 1

işlevler.bölge('us-doğu1')

Örnek 2

işlevler.bölge('biz-doğu1', 'biz-merkez1')

FunctionBuilder.runWith()

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

İmza:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Parametreler

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

İadeler:

Fonksiyon Oluşturucu