Функции
| Функция | Описание |
|---|---|
| defineBoolean(имя, параметры) | Объявите логический параметр. |
| defineInt(имя, параметры) | Объявите целочисленный параметр. |
| defineList(имя, параметры) | Объявите параметр списка. |
| defineSecret(имя) | Объявляет секретный параметр, значения которого будут сохраняться только в Cloud Secret Manager. Секреты хранятся внутри в виде байтовых строк. Используйте ParamOptions.as для предоставления подсказок типа во время разрешения параметров. |
| defineString (имя, параметры) | Объявите строковый параметр. |
| multiSelect(опции) | Создайте ввод с множественным выбором из серии значений. |
| multiSelect(опции) | Создайте ввод с множественным выбором из карты меток и значений. |
| выбрать (варианты) | Создайте входные данные выбора из серии значений. |
| выберите (опции с метками) | Создайте входные данные выбора из карты меток и значений. |
Классы
| Сорт | Описание |
|---|---|
| Выражение |
Интерфейсы
| Интерфейс | Описание |
|---|---|
| Мультиселектинпут | Указывает, что значение параметра должно определяться путем интерактивного выбора пользователем подмножества из списка заранее подготовленных параметров во время развертывания. Приведет к ошибкам, если использовать его с параметрами типа, отличного от string[] . |
| СелектИнпут | Указывает, что значение параметра должно определяться путем интерактивного выбора пользователем из списка заранее подготовленных параметров во время развертывания. |
| ВыберитеПараметры | Один из параметров, предоставляемых SelectInput , содержащий значение и, при необходимости, удобочитаемую метку для отображения в интерфейсе выбора. |
| Ввод текста | Указывает, что значение параметра должно определяться путем запроса пользователя ввести его в интерактивном режиме во время развертывания. Ввод, который не соответствует предоставленному validationRegex, если он присутствует, будет повторен. |
Переменные
| Переменная | Описание |
|---|---|
| BUCKET_PICKER | Автоматически сгенерируйте список сегментов в проекте, из которого пользователь может выбирать. |
| URL базы данных | Встроенный параметр, который преобразуется в URL-адрес базы данных RTDB по умолчанию, связанный с проектом, без запроса средства развертывания. Пустая строка, если ее нет. |
| объявленные параметры | |
| gcloudProject | Встроенный параметр, который преобразуется в идентификатор облачного проекта без запроса средств развертывания. |
| идентификатор проекта | Встроенный параметр, который преобразуется в идентификатор облачного проекта, связанный с проектом, без запроса средства развертывания. |
| хранилищеВедро | Встроенный параметр, который разрешает сегмент облачного хранилища, связанный с функцией, без запроса развертывателя. Пустая строка, если не определена. |
Введите псевдонимы
| Введите псевдоним | Описание |
|---|---|
| ПарамОпции | Параметры конфигурации, которые можно использовать для настройки поведения подсказок параметра. |
параметры.defineBoolean()
Объявите логический параметр.
Подпись:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| имя | нить | Имя переменной среды, используемой для загрузки параметра. |
| параметры | ПарамОпции <логическое значение> | Параметры конфигурации параметра. |
Возврат:
BooleanParam
Параметр с boolean типом возвращаемого значения для .value .
параметры.defineInt()
Объявите целочисленный параметр.
Подпись:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| имя | нить | Имя переменной среды, используемой для загрузки параметра. |
| параметры | ПарамОпции <номер> | Параметры конфигурации параметра. |
Возврат:
ИнтПарам
Параметр с number типом возвращаемого значения для .value .
параметры.defineList()
Объявите параметр списка.
Подпись:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| имя | нить | Имя переменной среды, используемой для загрузки параметра. |
| параметры | ПарамОпции <строка[]> | Параметры конфигурации параметра. |
Возврат:
СписокПарам
Параметр с возвращаемым типом string[] для .value .
параметры.defineSecret()
Объявляет секретный параметр, значения которого будут сохраняться только в Cloud Secret Manager. Секреты хранятся внутри в виде байтовых строк. Используйте ParamOptions.as для предоставления подсказок типа во время разрешения параметров.
Подпись:
export declare function defineSecret(name: string): SecretParam;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| имя | нить | Имя переменной среды, используемой для загрузки параметра. |
Возврат:
СекретПарам
Параметр со string типом возврата для .value .
параметры.defineString()
Объявите строковый параметр.
Подпись:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| имя | нить | Имя переменной среды, используемой для загрузки параметра. |
| параметры | ПарамОпции <строка> | Параметры конфигурации параметра. |
Возврат:
СтроковыйПарам
Параметр со string типом возврата для .value .
параметры.multiSelect()
Создайте ввод с множественным выбором из серии значений.
Подпись:
export declare function multiSelect(options: string[]): MultiSelectInput;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| параметры | нить[] |
Возврат:
параметры.multiSelect()
Создайте ввод с множественным выбором из карты меток и значений.
Подпись:
export declare function multiSelect(options: Record<string, string>): MultiSelectInput;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| параметры | Запись<строка, строка> |
Возврат:
параметры.выбрать()
Создайте входные данные выбора из серии значений.
Подпись:
export declare function select<T>(options: T[]): SelectInput<T>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| параметры | Т[] |
Возврат:
СелектИнпут <Т>
параметры.выбрать()
Создайте входные данные выбора из карты меток и значений.
Подпись:
export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| варианты с метками | Запись<строка, Т> |
Возврат:
СелектИнпут <Т>
параметры.BUCKET_PICKER
Автоматически сгенерируйте список сегментов в проекте, из которого пользователь может выбирать.
Подпись:
BUCKET_PICKER: ResourceInput
params.databaseURL
Встроенный параметр, который преобразуется в URL-адрес базы данных RTDB по умолчанию, связанный с проектом, без запроса средства развертывания. Пустая строка, если ее нет.
Подпись:
databaseURL: Param<string>
params.declaredParams
Подпись:
declaredParams: SecretOrExpr[]
params.gcloudProject
Встроенный параметр, который преобразуется в идентификатор облачного проекта без запроса средств развертывания.
Подпись:
gcloudProject: Param<string>
параметры.projectID
Встроенный параметр, который преобразуется в идентификатор облачного проекта, связанный с проектом, без запроса средства развертывания.
Подпись:
projectID: Param<string>
params.storageBucket
Встроенный параметр, который разрешает сегмент облачного хранилища, связанный с функцией, без запроса развертывателя. Пустая строка, если не определена.
Подпись:
storageBucket: Param<string>
параметры.ParamOptions
Параметры конфигурации, которые можно использовать для настройки поведения подсказок параметра.
Подпись:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;