FunctionBuilder class

署名:

export declare class FunctionBuilder

コンストラクタ

コンストラクタ 修飾キー 説明
(コンストラクタ)(オプション) FunctionBuilder クラスの新しいインスタンスを作成します。

プロパティ

プロパティ 修飾キー タイプ 説明
アナリティクス { event: (analyticsEventType: 文字列) =>analytics.AnalyticsEventBuilder;}
認証 {ユーザー: (userOptions?: auth.UserOptions) =>auth.UserBuilder;}
データベース { インスタンス: (instance: string) =>database.InstanceBuilder;ref: <Ref extends string>(path: Ref) =>database.RefBuilder<Ref>;}
firestore { document: <パス拡張文字列>(パス: パス) =>firestore.DocumentBuilder<Path>;namespace: (namespace: string) =>firestore.NamespaceBuilder;database: (database: string) =>（データベース: 文字列）firestore.DatabaseBuilder;}
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>;}
Pub/Sub { topic: (topic: string) => pubsub.TopicBuilder;schedule: (schedule: string) =>pubsub.ScheduleBuilder;}
remoteConfig { onUpdate: (handler: (version: remoteConfig.TemplateVersion, context: EventContext) => PromiseLike<any> | any) =>import("./cloud-functions")CloudFunction<remoteConfig.TemplateVersion>;}
ストレージ {bucket: (bucket?: 文字列) =>storage.BucketBuilder;オブジェクト: () =>storage.ObjectBuilder;}
タスク { taskQueue: (options?: tasks.TaskQueueOptions) =>tasks.TaskQueueBuilder;}
testLab { testMatrix: () =>testLab.TestMatrixBuilder;}

メソッド

メソッド 修飾キー 説明
region（regions） 関数をデプロイするリージョンを構成します。
runWith(runtimeOptions) 関数のランタイム オプションを構成します。

FunctionBuilder.（コンストラクタ）

FunctionBuilder クラスの新しいインスタンスを作成します。

署名:

constructor(options: DeploymentOptions);

パラメータ

パラメータ 型 説明
オプション DeploymentOptions

FunctionBuilder.analytics

署名:

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

FunctionBuilder.auth

署名:

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

FunctionBuilder.database

署名:

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;

パラメータ

パラメータ 型 説明
リージョン 配列<(typeof SUPPORTED_REGIONS)[number] |文字列 |式<string>|ResetValue> 1 つ以上の地域文字列。

戻り値:

FunctionBuilder

例 1

functions.region('us-east1')

例 2

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

FunctionBuilder.runWith()

関数のランタイム オプションを構成します。

署名:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

パラメータ

パラメータ 型 説明
runtimeOptions RuntimeOptions オプション フィールドを含むオブジェクト: 1.memory: 関数に割り当てるメモリの量。有効な値は、128MB、256MB、512MB、1GB、2GB、4GB、8GB です。2. timeoutSeconds: 関数のタイムアウト（秒単位）。有効な値は 0 ～ 540 です。3. failurePolicy: 関数の失敗ポリシー。ブール値 true は空の再試行オブジェクトを提供するのと同等です。4. vpcConnector: 同じプロジェクトとリージョン 5 内の VPC コネクタの ID。vpcConnectorEgressSettings: vpcConnector が設定されている場合、vpcConnector を介して送信される下り（外向き）トラフィックを制御します。値を null にすることはできません。

戻り値:

FunctionBuilder