Funkcje
Funkcjonować | Opis |
---|---|
zdefiniujBoolean(nazwa, opcje) | Zadeklaruj parametr logiczny. |
zdefiniujInt(nazwa, opcje) | Zadeklaruj parametr będący liczbą całkowitą. |
zdefiniujList(nazwa, opcje) | Zadeklaruj parametr listy. |
zdefiniujSecret(nazwa) | Deklaruje tajny parametr, który będzie utrwalał wartości tylko w Cloud Secret Manager. Sekrety są przechowywane wewnętrznie jako ciągi bajtowe. Użyj ParamOptions.as , aby zapewnić wskazówki dotyczące typu podczas rozpoznawania parametrów. |
zdefiniujString(nazwa, opcje) | Zadeklaruj parametr ciągu. |
multiSelect(opcje) | Utwórz wejście wielokrotnego wyboru na podstawie serii wartości. |
multiSelect(opcje) | Utwórz dane wejściowe wielokrotnego wyboru z mapy etykiet na wartości. |
Wybierz opcje) | Utwórz wybrane wejście z serii wartości. |
wybierz(opcjez etykietami) | Utwórz wybrane dane wejściowe z mapy etykiet na wartości. |
Zajęcia
Klasa | Opis |
---|---|
Wyrażenie |
Interfejsy
Interfejs | Opis |
---|---|
Wejście MultiSelect | Określa, że wartość parametru powinna zostać określona przez użytkownika, który wybierze podzbiór z listy wstępnie skonfigurowanych opcji w czasie wdrażania. Spowoduje błędy, jeśli zostanie użyte z parametrami typu innego niż string[] . |
Wybierz opcję Wejście | Określa, że wartość parametru powinna zostać określona poprzez interaktywny wybór przez użytkownika z listy wstępnie skonfigurowanych opcji w czasie wdrażania. |
Wybierz opcje | Jedna z opcji dostępnych dla SelectInput , zawierająca wartość i opcjonalnie etykietę czytelną dla człowieka, która ma być wyświetlana w interfejsie wyboru. |
Wprowadzanie tekstu | Określa, że wartość parametru powinna zostać określona poprzez monitowanie użytkownika o interaktywne wpisanie go w czasie wdrażania. Dane wejściowe, które nie pasują do podanego wyrażenia validationRegex, jeśli są obecne, zostaną ponowione. |
Zmienne
Zmienny | Opis |
---|---|
BUCKET_PICKER | Automatycznie wygeneruj listę zasobników w projekcie, spośród których użytkownik może wybierać. |
adres URL bazy danych | Wbudowany parametr, który przekształca domyślny adres URL bazy danych RTDB powiązany z projektem, bez monitowania osoby wdrażającej. Pusty ciąg znaków, jeśli żaden nie istnieje. |
zadeklarowaneParamy | |
gcloudProject | Wbudowany parametr, który jest rozpoznawany jako identyfikator projektu Cloud bez monitowania osoby wdrażającej. |
identyfikator projektu | Wbudowany parametr, który jest rozpoznawany jako identyfikator projektu Cloud powiązany z projektem, bez monitowania wdrażającego. |
Wiadro do przechowywania | Wbudowany parametr, który identyfikuje zasobnik w chmurze powiązany z funkcją, bez monitowania wdrażającego. Pusty ciąg znaków, jeśli nie został zdefiniowany. |
Wpisz aliasy
Wpisz Alias | Opis |
---|---|
Opcje parametrów | Opcje konfiguracyjne, których można użyć do dostosowania zachowania monitowania parametru. |
parametry.definicjaBoolean()
Zadeklaruj parametr logiczny.
Podpis:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Parametry
Parametr | Typ | Opis |
---|---|---|
nazwa | strunowy | Nazwa zmiennej środowiskowej, która ma zostać użyta do załadowania parametru. |
opcje | Opcje parametrów <wartość logiczna> | Opcje konfiguracji parametru. |
Zwroty:
Wartość logiczna
Parametr zwracany w postaci boolean
dla .value
.
parametry.definicjaInt()
Zadeklaruj parametr będący liczbą całkowitą.
Podpis:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Parametry
Parametr | Typ | Opis |
---|---|---|
nazwa | strunowy | Nazwa zmiennej środowiskowej, która ma zostać użyta do załadowania parametru. |
opcje | Opcje parametrów <numer> | Opcje konfiguracji parametru. |
Zwroty:
Parametr wewnętrzny
Parametr zwracający typ number
dla .value
.
parametry.definicjaLista()
Zadeklaruj parametr listy.
Podpis:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Parametry
Parametr | Typ | Opis |
---|---|---|
nazwa | strunowy | Nazwa zmiennej środowiskowej, która ma zostać użyta do załadowania parametru. |
opcje | Opcje parametrów <ciąg[]> | Opcje konfiguracji parametru. |
Zwroty:
ListaParam
Parametr z zwracanym typem string[]
dla .value
.
parametry.definicjaSecret()
Deklaruje tajny parametr, który będzie utrwalał wartości tylko w Cloud Secret Manager. Sekrety są przechowywane wewnętrznie jako ciągi bajtowe. Użyj ParamOptions.as
, aby zapewnić wskazówki dotyczące typu podczas rozpoznawania parametrów.
Podpis:
export declare function defineSecret(name: string): SecretParam;
Parametry
Parametr | Typ | Opis |
---|---|---|
nazwa | strunowy | Nazwa zmiennej środowiskowej, która ma zostać użyta do załadowania parametru. |
Zwroty:
SekretnyParam
Parametr z zwracanym typem string
dla .value
.
parametry.definicjaString()
Zadeklaruj parametr ciągu.
Podpis:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Parametry
Parametr | Typ | Opis |
---|---|---|
nazwa | strunowy | Nazwa zmiennej środowiskowej, która ma zostać użyta do załadowania parametru. |
opcje | Opcje parametrów <ciąg> | Opcje konfiguracji parametru. |
Zwroty:
Parametr ciągu
Parametr z zwracanym typem string
dla .value
.
params.multiSelect()
Utwórz wejście wielokrotnego wyboru na podstawie serii wartości.
Podpis:
export declare function multiSelect(options: string[]): MultiSelectInput;
Parametry
Parametr | Typ | Opis |
---|---|---|
opcje | strunowy[] |
Zwroty:
params.multiSelect()
Utwórz dane wejściowe wielokrotnego wyboru z mapy etykiet na wartości.
Podpis:
export declare function multiSelect(options: Record<string, string>): MultiSelectInput;
Parametry
Parametr | Typ | Opis |
---|---|---|
opcje | Rekord<ciąg, ciąg> |
Zwroty:
parametry.select()
Utwórz wybrane wejście z serii wartości.
Podpis:
export declare function select<T>(options: T[]): SelectInput<T>;
Parametry
Parametr | Typ | Opis |
---|---|---|
opcje | T[] |
Zwroty:
parametry.select()
Utwórz wybrane dane wejściowe z mapy etykiet na wartości.
Podpis:
export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;
Parametry
Parametr | Typ | Opis |
---|---|---|
opcjeZ Etykietami | Rekord<ciąg, T> |
Zwroty:
parametry.BUCKET_PICKER
Automatycznie wygeneruj listę zasobników w projekcie, spośród których użytkownik może wybierać.
Podpis:
BUCKET_PICKER: ResourceInput
params.databaseURL
Wbudowany parametr, który zwraca domyślny adres URL bazy danych RTDB powiązany z projektem, bez monitowania osoby wdrażającej. Pusty ciąg znaków, jeśli żaden nie istnieje.
Podpis:
databaseURL: Param<string>
params.deklarowaneParams
Podpis:
declaredParams: SecretOrExpr[]
params.gcloudProject
Wbudowany parametr, który jest rozpoznawany jako identyfikator projektu w chmurze bez monitowania osoby wdrażającej.
Podpis:
gcloudProject: Param<string>
parametry.projectID
Wbudowany parametr, który jest rozpoznawany jako identyfikator projektu Cloud powiązany z projektem, bez monitowania wdrażającego.
Podpis:
projectID: Param<string>
params.storageBucket
Wbudowany parametr, który identyfikuje zasobnik w chmurze powiązany z funkcją, bez monitowania wdrażającego. Pusty ciąg znaków, jeśli nie został zdefiniowany.
Podpis:
storageBucket: Param<string>
params.ParamOpcje
Opcje konfiguracyjne, których można użyć do dostosowania zachowania monitowania parametru.
Podpis:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;