関数
| 関数 | 説明 |
|---|---|
| define ブール値(名前, オプション) | ブール値パラメータを宣言します。 |
| defineInt(名前, オプション) | 整数パラメータを宣言します。 |
| defineList(名前, オプション) | リスト パラメータを宣言します。 |
| DefineSecret(name) | Cloud Secret Manager 内でのみ値を保持するシークレット パラメータを宣言します。Secret はバイト文字列として内部的に保存されます。ParamOptions.as を使用して、パラメータの解決時に型ヒントを提供します。 |
| defineString(name, options) | 文字列パラメータを宣言します。 |
クラス
| クラス | 説明 |
|---|---|
| 式 |
変数
| 変数 | 説明 |
|---|---|
| databaseURL | デプロイ担当者にプロンプトを表示せずに、プロジェクトに関連付けられたデフォルトの RTDB データベース URL に解決される組み込みパラメータ。存在しない場合は空の文字列。 |
| declaredParams | |
| gcloudProject | デプロイ担当者にプロンプトを表示せずに、Cloud プロジェクト ID に解決される組み込みパラメータ。 |
| projectID | プロジェクトに関連付けられた Cloud プロジェクト ID に解決される組み込みパラメータ。デプロイ担当者へのプロンプトは表示されません。 |
| storageBucket | デプロイ担当者にプロンプトを表示せずに、関数に関連付けられた Cloud Storage バケットに解決される組み込みパラメータ。定義されていない場合は空の文字列。 |
型エイリアス
| 型エイリアス | 説明 |
|---|---|
| ParamOptions | Param のプロンプト動作をカスタマイズするために使用できる設定オプション。 |
params.defineBoolean()
ブール値パラメータを宣言します。
署名:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| name | 文字列 | パラメータの読み込みに使用する環境変数の名前。 |
| オプション | ParamOptions<ブール値> | パラメータの構成オプション。 |
戻り値:
ブール値パラメータ
.value に対する戻り値の型が boolean のパラメータ。
params.defineInt()
整数パラメータを宣言します。
署名:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| name | 文字列 | パラメータの読み込みに使用する環境変数の名前。 |
| オプション | ParamOptions<数値> | パラメータの構成オプション。 |
戻り値:
整数パラメータ
.value に対する戻り値の型が number のパラメータ。
params.defineList()
リスト パラメータを宣言します。
署名:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| name | 文字列 | パラメータの読み込みに使用する環境変数の名前。 |
| オプション | ParamOptions<文字列 []> | パラメータの構成オプション。 |
戻り値:
リスト パラメータ
.value に対する戻り値の型が string[] のパラメータ。
params.defineSecret()
Cloud Secret Manager 内でのみ値を保持するシークレット パラメータを宣言します。Secret はバイト文字列として内部的に保存されます。ParamOptions.as を使用して、パラメータの解決時に型ヒントを提供します。
署名:
export declare function defineSecret(name: string): SecretParam;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| name | 文字列 | パラメータの読み込みに使用する環境変数の名前。 |
戻り値:
SecretParam
.value に対する戻り値の型が string のパラメータ。
params.defineString()
文字列パラメータを宣言します。
署名:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| name | 文字列 | パラメータの読み込みに使用する環境変数の名前。 |
| オプション | ParamOptions<文字列> | パラメータの構成オプション。 |
戻り値:
StringParam
.value に対する戻り値の型が string のパラメータ。
params.databaseURL
デプロイ担当者にプロンプトを表示せずに、プロジェクトに関連付けられたデフォルトの RTDB データベース URL に解決される組み込みパラメータ。存在しない場合は空の文字列。
署名:
databaseURL: Param<string>
params.declaredParams
署名:
declaredParams: SecretOrExpr[]
params.gcloudProject
デプロイ担当者にプロンプトを表示せずに、Cloud プロジェクト ID に解決される組み込みパラメータ。
署名:
gcloudProject: Param<string>
params.projectID
プロジェクトに関連付けられた Cloud プロジェクト ID に解決される組み込みパラメータ。デプロイ担当者へのプロンプトは表示されません。
署名:
projectID: Param<string>
params.storageBucket
デプロイ担当者にプロンプトを表示せずに、関数に関連付けられた Cloud Storage バケットに解決される組み込みパラメータ。定義されていない場合は空の文字列。
署名:
storageBucket: Param<string>
params.ParamOptions
Param のプロンプト動作をカスタマイズするために使用できる設定オプション。
署名:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;