機能
関数 | 説明 |
---|---|
defineBoolean(名前, オプション) | ブール型パラメータを宣言します。 |
defineInt(名前, オプション) | 整数パラメータを宣言します。 |
defineList(名前, オプション) | リストパラメータを宣言します。 |
秘密を定義(名前) | Cloud Secret Manager でのみ値を保持するシークレット パラメータを宣言します。シークレットはバイト文字列として内部に保存されます。 ParamOptions.as を使用して、パラメーターの解決中に型ヒントを提供します。 |
定義文字列(名前、オプション) | 文字列パラメータを宣言します。 |
multiSelect(オプション) | 一連の値から複数選択入力を作成します。 |
multiSelect(オプション) | ラベルと値のマップから複数選択入力を作成します。 |
オプションを選択) | 一連の値から選択入力を作成します。 |
select(ラベル付きオプション) | ラベルと値のマップから選択入力を作成します。 |
クラス
クラス | 説明 |
---|---|
表現 |
インターフェース
インターフェース | 説明 |
---|---|
マルチ選択入力 | デプロイ時にユーザーが事前に用意されたオプションのリストからサブセットを対話的に選択することで、パラメーターの値を決定する必要があることを指定します。 string[] 以外の型のパラメータで使用するとエラーが発生します。 |
入力の選択 | デプロイ時にユーザーが事前に用意されたオプションのリストから対話的に選択することで、パラメーターの値を決定する必要があることを指定します。 |
オプションを選択 | SelectInput に提供されるオプションの 1 つ。値と、オプションで選択インターフェイスに表示する人間が判読できるラベルが含まれます。 |
テキスト入力 | デプロイ時にユーザーに対話形式でパラメーターの値を入力するよう求めることで、パラメーターの値を決定する必要があることを指定します。提供された validationRegex に一致しない入力が存在する場合、再試行されます。 |
変数
変数 | 説明 |
---|---|
バケットピッカー | ユーザーが選択できるプロジェクト内のバケットのリストを自動生成します。 |
データベースURL | デプロイヤにプロンプトを表示せずに、プロジェクトに関連付けられたデフォルトの RTDB データベース URL に解決される組み込みパラメータ。存在しない場合は空の文字列。 |
宣言されたパラメータ | |
gcloudプロジェクト | デプロイ担当者にプロンプトを表示せずに、クラウド プロジェクト ID に解決される組み込みパラメータ。 |
プロジェクトID | デプロイヤにプロンプトを表示せずに、プロジェクトに関連付けられたクラウド プロジェクト ID に解決される組み込みパラメータ。 |
保管バケツ | デプロイ担当者にプロンプトを表示せずに、関数に関連付けられたクラウド ストレージ バケットに解決される組み込みパラメータ。定義されていない場合は空の文字列。 |
タイプエイリアス
タイプエイリアス | 説明 |
---|---|
パラメータオプション | パラメータのプロンプト動作をカスタマイズするために使用できる構成オプション。 |
params.defineBoolean()
ブール型パラメータを宣言します。
サイン:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
名前 | 弦 | パラメータをロードするために使用する環境変数の名前。 |
オプション | パラメータオプション<ブール値> | パラメータの構成オプション。 |
戻り値:
ブールパラメータ
.value
の戻り値の型がboolean
パラメーター。
params.defineInt()
整数パラメータを宣言します。
サイン:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
名前 | 弦 | パラメータをロードするために使用する環境変数の名前。 |
オプション | パラメータオプション<番号> | パラメータの構成オプション。 |
戻り値:
IntParam
.value
の戻り値の型がnumber
であるパラメータ。
params.defineList()
リストパラメータを宣言します。
サイン:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
名前 | 弦 | パラメータをロードするために使用する環境変数の名前。 |
オプション | パラメータオプション<文字列[]> | パラメータの構成オプション。 |
戻り値:
リストパラメータ
.value
の戻り値の型がstring[]
のパラメータ。
params.defineSecret()
Cloud Secret Manager でのみ値を保持するシークレット パラメータを宣言します。シークレットはバイト文字列として内部に保存されます。 ParamOptions.as
を使用して、パラメーターの解決中に型ヒントを提供します。
サイン:
export declare function defineSecret(name: string): SecretParam;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
名前 | 弦 | パラメータをロードするために使用する環境変数の名前。 |
戻り値:
SecretParam
.value
の戻り値の型がstring
列であるパラメータ。
params.defineString()
文字列パラメータを宣言します。
サイン:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
名前 | 弦 | パラメータをロードするために使用する環境変数の名前。 |
オプション | パラメータオプション<文字列> | パラメータの構成オプション。 |
戻り値:
文字列パラメータ
.value
の戻り値の型がstring
列であるパラメータ。
params.multiSelect()
一連の値から複数選択入力を作成します。
サイン:
export declare function multiSelect(options: string[]): MultiSelectInput;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
オプション | 弦[] |
戻り値:
params.multiSelect()
ラベルと値のマップから複数選択入力を作成します。
サイン:
export declare function multiSelect(options: Record<string, string>): MultiSelectInput;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
オプション | レコード<文字列、文字列> |
戻り値:
params.select()
一連の値から選択入力を作成します。
サイン:
export declare function select<T>(options: T[]): SelectInput<T>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
オプション | T[] |
戻り値:
入力の選択<T>
params.select()
ラベルと値のマップから選択入力を作成します。
サイン:
export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
ラベル付きオプション | レコード<文字列, T> |
戻り値:
入力の選択<T>
params.BUCKET_PICKER
ユーザーが選択できるプロジェクト内のバケットのリストを自動生成します。
サイン:
BUCKET_PICKER: ResourceInput
params.databaseURL
デプロイヤーにプロンプトを表示せずに、プロジェクトに関連付けられたデフォルトの RTDB データベース URL に解決される組み込みパラメーター。存在しない場合は空の文字列。
サイン:
databaseURL: Param<string>
params.declaredParams
サイン:
declaredParams: SecretOrExpr[]
params.gcloudプロジェクト
デプロイ担当者にプロンプトを表示せずに、クラウド プロジェクト ID に解決される組み込みパラメータ。
サイン:
gcloudProject: Param<string>
params.プロジェクトID
デプロイヤーにプロンプトを表示せずに、プロジェクトに関連付けられたクラウド プロジェクト ID に解決される組み込みパラメーター。
サイン:
projectID: Param<string>
params.storageバケット
デプロイヤにプロンプトを表示せずに、関数に関連付けられたクラウド ストレージ バケットに解決される組み込みパラメータ。定義されていない場合は空の文字列。
サイン:
storageBucket: Param<string>
params.ParamOptions
パラメータのプロンプト動作をカスタマイズするために使用できる構成オプション。
サイン:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;