機能
| 関数 | 説明 |
|---|---|
| 構成() | サードパーティ API キーやその他の設定などのプロジェクト構成データを保存および取得します。 [環境設定](/docs/functions/config-env) で説明されているように、Firebase CLI を使用して設定値を設定できます。 |
| optionsToEndpoint(オプション) | |
| optionsToTrigger(オプション) | |
| 地域(地域) | 関数がデプロイされるリージョンを構成します。 |
| runWith(ランタイムオプション) | 関数の実行時オプションを構成します。 |
クラス
| クラス | 説明 |
|---|---|
| 変化 | Realtime Database や Cloud Firestore のonWriteイベントやonUpdateイベントなど、状態を変更するイベント用の Cloud Functions インターフェース。 Changeオブジェクトの構築に使用される形式の詳細については、以下を参照してください。 |
| 関数ビルダー |
インターフェース
| インターフェース | 説明 |
|---|---|
| ブロッキング機能 | 認証ブロックトリガーの関数タイプ。 |
| クラウドファンクション | すべての非 HTTPS トリガーの関数タイプ。 Cloud Function を定義するには、これを JavaScript ファイルからエクスポートする必要があります。この型は、テンプレート化されたEventオブジェクトを唯一の引数として受け取る特別な JavaScript 関数です。 |
| 導入オプション | 関数のデプロイメント中に適用される関数の構成オプション。 |
| イベント | イベントのワイヤー形式。 |
| イベントコンテキスト | イベントが発生したコンテキスト。 |
| 失敗ポリシー | バックグラウンド機能の障害ポリシーの構成オプション。 |
| Https関数 | HTTPS トリガーの関数タイプ。 Cloud Function を定義するには、これを JavaScript ファイルからエクスポートする必要があります。 |
| リソース | Resource は、リソースを定義するための標準形式です (google.rpc.context.AttributeContext.Resource)。 Cloud Functions では、ストレージ バケットなど、関数をトリガーしたリソースです。 |
| 実行可能 | Runnable には、単体テストに役立つユーザー定義関数を直接呼び出すrunメソッドがあります。 |
| ランタイムオプション | 実行時に適用できる関数の構成オプション。 |
| スケジュール | スケジュールされた機能の構成オプション。 |
| スケジュール再試行構成 | スケジューラの再試行オプション。スケジュールされた機能にのみ適用されます。 |
名前空間
| 名前空間 | 説明 |
|---|---|
| 分析 | |
| 認証 | |
| データベース | |
| 消防署 | |
| https | |
| ロガー | |
| パラメータ | |
| パブサブ | |
| リモート構成 | |
| ストレージ | |
| タスク | |
| テストラボ |
変数
| 変数 | 説明 |
|---|---|
| アプリ | |
| DEFAULT_FAILURE_POLICY | |
| INGRESS_SETTINGS_OPTIONS | IngressSettings で使用可能なオプションのリスト。 |
| MAX_NUMBER_USER_LABELS | |
| MAX_TIMEOUT_SECONDS | Cloud Functions の最大タイムアウト値。 |
| MIN_TIMEOUT_SECONDS | Cloud Functions の最小タイムアウト値。 |
| RESET_VALUE | 構成をプラットフォームのデフォルトにリセットするための特別な構成値。 |
| SUPPORTED_REGIONS | Cloud Functions でサポートされているすべてのリージョンのリスト。 |
| VALID_MEMORY_OPTIONS | Cloud Functions でサポートされている使用可能なメモリ オプションのリスト。 |
| VPC_EGRESS_SETTINGS_OPTIONS | VpcConnectorEgressSettings で使用可能なオプションのリスト。 |
構成()
サードパーティ API キーやその他の設定などのプロジェクト構成データを保存および取得します。 [環境設定](/docs/functions/config-env) で説明されているように、Firebase CLI を使用して設定値を設定できます。
サイン：
export declare function config(): Record<string, any>;
戻り値：
レコード<文字列、任意>
optionsToEndpoint()
サイン：
export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| オプション | 導入オプション |
戻り値：
マニフェストエンドポイント
optionsToTrigger()
サイン：
export declare function optionsToTrigger(options: DeploymentOptions): any;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| オプション | 導入オプション |
戻り値：
どれでも
地域（）
関数がデプロイされるリージョンを構成します。
サイン：
export declare function region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| 地域 | 配列<( SUPPORTED_REGIONSの種類)[数値] |文字列 |表現<文字列> |リセット値> | 1 つ以上の地域文字列。 |
戻り値：
例1
関数.region('us-east1')
例 2
関数.region('us-east1', 'us-central1')
runWith()
関数の実行時オプションを構成します。
サイン：
export declare function runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| ランタイムオプション | ランタイムオプション | オプションのフィールドを持つオブジェクト: 1. memory : 関数に割り当てるメモリの量。可能な値は次のとおりです: '128MB'、'256MB'、'512MB'、'1GB'、'2GB'、'4GB'、および '8GB' 。 2. timeoutSeconds : 関数のタイムアウト (秒単位)。可能な値は 0 ～ 540 です。 3. failurePolicy : 関数の失敗ポリシー。ブールtrueは、空の再試行オブジェクトを提供するのと同等です。 4. vpcConnector : 同じプロジェクトおよびリージョン内の VPC コネクタの ID。 5. vpcConnectorEgressSettings : vpcConnector が設定されている場合、どの出力トラフィックが vpcConnector 経由で送信されるかを制御します。 6. serviceAccount : 関数の特定のサービス アカウント。 7. ingressSettings : 関数の入力設定。HTTPS 関数をどこから呼び出せるかを制御します。値は null であってはなりません。 |
戻り値：
アプリ
サイン：
app: {
setEmulatedAdminApp: typeof setEmulatedAdminApp;
}
DEFAULT_FAILURE_POLICY
サイン：
DEFAULT_FAILURE_POLICY: FailurePolicy
INGRESS_SETTINGS_OPTIONS
IngressSettings で使用可能なオプションのリスト。
サイン：
INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
MAX_NUMBER_USER_LABELS
サイン：
MAX_NUMBER_USER_LABELS = 58
MAX_TIMEOUT_SECONDS
Cloud Functions の最大タイムアウト値。
サイン：
MAX_TIMEOUT_SECONDS = 540
MIN_TIMEOUT_SECONDS
Cloud Functions の最小タイムアウト値。
サイン：
MIN_TIMEOUT_SECONDS = 0
RESET_VALUE
構成をプラットフォームのデフォルトにリセットするための特別な構成値。
サイン：
RESET_VALUE: ResetValue
SUPPORTED_REGIONS
Cloud Functions でサポートされているすべてのリージョンのリスト。
サイン：
SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"]
VALID_MEMORY_OPTIONS
Cloud Functions でサポートされている使用可能なメモリ オプションのリスト。
サイン：
VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"]
VPC_EGRESS_SETTINGS_OPTIONS
VpcConnectorEgressSettings で使用可能なオプションのリスト。
サイン：
VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]