params namespace

Funktionen

Funktion Beschreibung
defineBoolean(name, Optionen) Deklarieren Sie einen booleschen Parameter.
defineInt(name, Optionen) Deklarieren Sie einen ganzzahligen Parameter.
defineList(name, Optionen) Deklarieren Sie einen Listenparameter.
defineSecret(name) Deklariert einen geheimen Parameter, der Werte nur im Cloud Secret Manager beibehält. Geheimnisse werden intern als Bytestrings gespeichert. Verwenden Sie ParamOptions.as , um während der Parameterauflösung Typhinweise bereitzustellen.
defineString(name, Optionen) Deklarieren Sie einen String-Parameter.
multiSelect(Optionen) Erstellen Sie eine Mehrfachauswahleingabe aus einer Reihe von Werten.
multiSelect(Optionen) Erstellen Sie eine Mehrfachauswahleingabe von der Zuordnung von Beschriftungen zu Werten.
Optionen wählen) Erstellen Sie eine ausgewählte Eingabe aus einer Reihe von Werten.
select(optionsWithLabels) Erstellen Sie eine ausgewählte Eingabe aus einer Zuordnung von Beschriftungen zu Werten.

Klassen

Klasse Beschreibung
Ausdruck

Schnittstellen

Schnittstelle Beschreibung
MultiSelectInput Gibt an, dass der Wert eines Parameters bestimmt werden soll, indem der Benutzer zum Zeitpunkt der Bereitstellung interaktiv eine Teilmenge aus einer Liste vorgefertigter Optionen auswählt. Führt zu Fehlern, wenn es für Parameter eines anderen Typs als string[] verwendet wird.
Wählen Sie Eingabe Gibt an, dass der Wert eines Parameters dadurch bestimmt werden soll, dass der Benutzer zum Zeitpunkt der Bereitstellung interaktiv aus einer Liste vorgefertigter Optionen auswählt.
Optionen wählen Eine der für SelectInput bereitgestellten Optionen, die einen Wert und optional eine für Menschen lesbare Bezeichnung zur Anzeige in der Auswahlschnittstelle enthält.
Text Eingabe Gibt an, dass der Wert eines Parameters ermittelt werden soll, indem der Benutzer zum Zeitpunkt der Bereitstellung aufgefordert wird, ihn interaktiv einzugeben. Eingaben, die nicht mit dem bereitgestellten validationRegex übereinstimmen, sofern vorhanden, werden erneut versucht.

Variablen

Variable Beschreibung
BUCKET_PICKER Generieren Sie automatisch eine Liste von Buckets in einem Projekt, aus denen ein Benutzer auswählen kann.
DatenbankURL Ein integrierter Parameter, der ohne Aufforderung an den Bereitsteller in die mit dem Projekt verknüpfte Standard-RTDB-Datenbank-URL aufgelöst wird. Leere Zeichenfolge, falls keine vorhanden ist.
deklarierteParams
gcloudProject Ein integrierter Parameter, der in die Cloud-Projekt-ID aufgelöst wird, ohne den Bereitsteller dazu aufzufordern.
Projekt-ID Ein integrierter Parameter, der in die mit dem Projekt verknüpfte Cloud-Projekt-ID aufgelöst wird, ohne dass der Bereitsteller dazu aufgefordert wird.
storageBucket Ein integrierter Parameter, der in den mit der Funktion verknüpften Cloud-Speicher-Bucket aufgelöst wird, ohne den Bereitsteller dazu aufzufordern. Leere Zeichenfolge, falls nicht definiert.

Geben Sie Aliase ein

Geben Sie Alias ​​ein Beschreibung
ParamOptions Konfigurationsoptionen, mit denen das Aufforderungsverhalten eines Parameters angepasst werden kann.

params.defineBoolean()

Deklarieren Sie einen booleschen Parameter.

Unterschrift:

export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;

Parameter

Parameter Typ Beschreibung
Name Zeichenfolge Der Name der Umgebungsvariablen, die zum Laden des Parameters verwendet werden soll.
Optionen ParamOptions <boolean> Konfigurationsoptionen für den Parameter.

Kehrt zurück:

BooleanParam

Ein Parameter mit einem boolean Rückgabetyp für .value .

params.defineInt()

Deklarieren Sie einen ganzzahligen Parameter.

Unterschrift:

export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;

Parameter

Parameter Typ Beschreibung
Name Zeichenfolge Der Name der Umgebungsvariablen, die zum Laden des Parameters verwendet werden soll.
Optionen ParamOptions <Nummer> Konfigurationsoptionen für den Parameter.

Kehrt zurück:

IntParam

Ein Parameter mit einem number für .value .

params.defineList()

Deklarieren Sie einen Listenparameter.

Unterschrift:

export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;

Parameter

Parameter Typ Beschreibung
Name Zeichenfolge Der Name der Umgebungsvariablen, die zum Laden des Parameters verwendet werden soll.
Optionen ParamOptions <string[]> Konfigurationsoptionen für den Parameter.

Kehrt zurück:

ListParam

Ein Parameter mit einem string[] -Rückgabetyp für .value .

params.defineSecret()

Deklariert einen geheimen Parameter, der Werte nur im Cloud Secret Manager beibehält. Geheimnisse werden intern als Bytestrings gespeichert. Verwenden Sie ParamOptions.as , um während der Parameterauflösung Typhinweise bereitzustellen.

Unterschrift:

export declare function defineSecret(name: string): SecretParam;

Parameter

Parameter Typ Beschreibung
Name Zeichenfolge Der Name der Umgebungsvariablen, die zum Laden des Parameters verwendet werden soll.

Kehrt zurück:

SecretParam

Ein Parameter mit einem string Rückgabetyp für .value .

params.defineString()

Deklarieren Sie einen String-Parameter.

Unterschrift:

export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;

Parameter

Parameter Typ Beschreibung
Name Zeichenfolge Der Name der Umgebungsvariablen, die zum Laden des Parameters verwendet werden soll.
Optionen ParamOptions <string> Konfigurationsoptionen für den Parameter.

Kehrt zurück:

StringParam

Ein Parameter mit einem string Rückgabetyp für .value .

params.multiSelect()

Erstellen Sie eine Mehrfachauswahleingabe aus einer Reihe von Werten.

Unterschrift:

export declare function multiSelect(options: string[]): MultiSelectInput;

Parameter

Parameter Typ Beschreibung
Optionen string[]

Kehrt zurück:

MultiSelectInput

params.multiSelect()

Erstellen Sie eine Mehrfachauswahleingabe von der Zuordnung von Beschriftungen zu Werten.

Unterschrift:

export declare function multiSelect(options: Record<string, string>): MultiSelectInput;

Parameter

Parameter Typ Beschreibung
Optionen Record<string, string>

Kehrt zurück:

MultiSelectInput

params.select()

Erstellen Sie eine ausgewählte Eingabe aus einer Reihe von Werten.

Unterschrift:

export declare function select<T>(options: T[]): SelectInput<T>;

Parameter

Parameter Typ Beschreibung
Optionen T[]

Kehrt zurück:

Wählen Sie Eingabe <T>

params.select()

Erstellen Sie eine ausgewählte Eingabe aus einer Zuordnung von Beschriftungen zu Werten.

Unterschrift:

export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;

Parameter

Parameter Typ Beschreibung
OptionenWithLabels Record<string, T>

Kehrt zurück:

Wählen Sie Eingabe <T>

params.BUCKET_PICKER

Generieren Sie automatisch eine Liste von Buckets in einem Projekt, aus denen ein Benutzer auswählen kann.

Unterschrift:

BUCKET_PICKER: ResourceInput

params.databaseURL

Ein integrierter Parameter, der ohne Aufforderung an den Bereitsteller in die mit dem Projekt verknüpfte Standard-RTDB-Datenbank-URL aufgelöst wird. Leere Zeichenfolge, falls keine vorhanden ist.

Unterschrift:

databaseURL: Param<string>

params.declaredParams

Unterschrift:

declaredParams: SecretOrExpr[]

params.gcloudProject

Ein integrierter Parameter, der in die Cloud-Projekt-ID aufgelöst wird, ohne den Bereitsteller dazu aufzufordern.

Unterschrift:

gcloudProject: Param<string>

params.projectID

Ein integrierter Parameter, der in die mit dem Projekt verknüpfte Cloud-Projekt-ID aufgelöst wird, ohne dass der Bereitsteller dazu aufgefordert wird.

Unterschrift:

projectID: Param<string>

params.storageBucket

Ein integrierter Parameter, der in den mit der Funktion verknüpften Cloud-Speicher-Bucket aufgelöst wird, ohne den Bereitsteller dazu aufzufordern. Leere Zeichenfolge, falls nicht definiert.

Unterschrift:

storageBucket: Param<string>

params.ParamOptions

Konfigurationsoptionen, mit denen das Aufforderungsverhalten eines Parameters angepasst werden kann.

Unterschrift:

export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;