FunctionBuilder class

簽名:

export declare class FunctionBuilder 

建構函數

建構函數修飾符描述
(構造函數)(選項)建構FunctionBuilder類別的新實例

特性

財產修飾符類型描述
分析{ 事件:(analyticsEventType:字串)=> Analytics.AnalyticsEventBuilder ; }
授權{ 使用者:(userOptions?: auth.UserOptions ) => auth.UserBuilder ; }
資料庫{ 實例:(實例:字串)=>資料庫​​.InstanceBuilder ; ref: <Ref 擴充字串>(path: Ref) => database.RefBuilder <參考>; }
火庫{ 文件:<路徑擴展字串>(路徑:路徑) => firestore.DocumentBuilder <路徑>;命名空間:(命名空間:字串)=> firestore.NamespaceBuilder ;資料庫:(資料庫:字串)=> firestore.DatabaseBuilder ; }
https { onRequest: (處理程序: (req: https.Request, resp:express.Response) => void | Promise<void>) => import("./cloud-functions"). Https函數; onCall: (處理程序: (資料: 任何, 上下文: https.CallableContext ) => 任一 | Promise<any>) => import("./cloud-functions"). HttpsFunction & import("./cloud-functions").可運行<任意>; }
發布訂閱{ 主題:(主題:字串)=> pubsub.TopicBuilder ;時間表:(時間表:字串)=> pubsub.ScheduleBuilder ; }
遠端配置{ onUpdate: (處理程序: (版本: remoteConfig.TemplateVersion , 上下文: EventContext ) => PromiseLike<任意> |任何)=>導入(“./雲函數”)。雲函數<遠端配置.TemplateVersion >; }
貯存{ 桶:(桶?:字串)=> storage.BucketBuilder ;物件:() => storage.ObjectBuilder ; }
任務{ 任務佇列:(選項?: tasks.TaskQueueOptions ) =>任務.TaskQueueBuilder ; }
測試實驗室{ testMatrix: () => testLab.TestMatrixBuilder ; }

方法

方法修飾符描述
地區(地區)配置功能部署到的區域。
runWith(運行時選項)配置函數的運行時選項。

FunctionBuilder.(建構子)

建構FunctionBuilder類別的新實例

簽名:

constructor(options: DeploymentOptions);

參數

範圍類型描述
選項部署選項

FunctionBuilder.analytics

簽名:

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

FunctionBuilder.auth

簽名:

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

FunctionBuilder.資料庫

簽名:

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

FunctionBuilder.firestore

簽名:

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

FunctionBuilder.https

簽名:

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

簽名:

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

FunctionBuilder.remoteConfig

簽名:

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

FunctionBuilder.storage

簽名:

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

FunctionBuilder.tasks

簽名:

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

FunctionBuilder.testLab

簽名:

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

FunctionBuilder.region()

配置功能部署到的區域。

簽名:

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

參數

範圍類型描述
地區數組 <( SUPPORTED_REGIONS類型)[數量] |字串|表達<字串> |重置值>一個或多個區域字串。

返回:

函數產生器

實施例1

函數.region('us-east1')

實施例2

函數.region('us-east1', 'us-central1')

FunctionBuilder.runWith()

配置函數的運行時選項。

簽名:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

參數

範圍類型描述
運行時選項運行時選項具有可選欄位的物件: 1. memory :分配給函數的記憶體量,可能的值為:'128MB'、'256MB'、'512MB'、'1GB'、'2GB'、'4GB' 和 '8GB' 。 2. timeoutSeconds :函數的逾時時間,單位為秒,可能的值為 0 到 540。3. failurePolicy :函數的失敗策略,boolean true相當於提供一個空的重試物件。 4. vpcConnector :同一專案與區域中的 VPC 連接器的 id 5. vpcConnectorEgressSettings :設定vpcConnector時,控制透過vpcConnector傳送哪些出口流量。值不能為空。

返回:

函數產生器