params namespace

Funzioni

Funzione Descrizione
defineBoolean(nome, opzioni) Dichiarare un parametro booleano.
defineInt(nome, opzioni) Dichiarare un parametro intero.
defineList(nome, opzioni) Dichiarare un parametro di lista.
defineSecret(nome) Dichiara un parametro segreto, che manterrà i valori solo in Cloud Secret Manager. I segreti vengono archiviati internamente come stringhe di byte. Utilizzare ParamOptions.as per fornire suggerimenti sul tipo durante la risoluzione dei parametri.
defineString(nome, opzioni) Dichiarare un parametro stringa.
multiSelect(opzioni) Crea un input a selezione multipla da una serie di valori.
multiSelect(opzioni) Crea un input a selezione multipla dalla mappa delle etichette ai valori.
seleziona (opzioni) Crea un input selezionato da una serie di valori.
select(opzioniConEtichette) Crea un input selezionato da una mappa di etichette a valori.

Classi

Classe Descrizione
Espressione

Interfacce

Interfaccia Descrizione
Ingresso a selezione multipla Specifica che il valore di un parametro deve essere determinato facendo in modo che l'utente selezioni un sottoinsieme da un elenco di opzioni predefinite in modo interattivo al momento della distribuzione. Verranno generati errori se utilizzati su parametri di tipo diverso da string[] .
Seleziona Ingresso Specifica che il valore di un parametro deve essere determinato facendo in modo che l'utente selezioni da un elenco di opzioni predefinite in modo interattivo al momento della distribuzione.
Seleziona Opzioni Una delle opzioni fornite a SelectInput , contenente un valore e facoltativamente un'etichetta leggibile dall'uomo da visualizzare nell'interfaccia di selezione.
L'immissione di testo Specifica che il valore di un parametro deve essere determinato richiedendo all'utente di digitarlo in modo interattivo al momento della distribuzione. L'input che non corrisponde al validationRegex fornito, se presente, verrà ritentato.

Variabili

Variabile Descrizione
BUCKET_PICKER Genera automaticamente un elenco di bucket in un progetto da cui un utente può selezionare.
URL del database Un parametro integrato che si risolve nell'URL del database RTDB predefinito associato al progetto, senza richiedere conferma al distributore. Stringa vuota se non esiste.
dichiaratoParams
gcloudProject Un parametro integrato che si risolve nell'ID del progetto cloud, senza richiedere conferma al distributore.
IDprogetto Un parametro integrato che si risolve nell'ID progetto cloud associato al progetto, senza richiedere conferma al distributore.
storageBucket Un parametro integrato che si risolve nel bucket di archiviazione cloud associato alla funzione, senza richiedere conferma al distributore. Stringa vuota se non definita.

Digitare Alias

Digita Alias Descrizione
ParamOptions Opzioni di configurazione che possono essere utilizzate per personalizzare il comportamento di richiesta di un parametro.

params.defineBoolean()

Dichiarare un parametro booleano.

Firma:

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

Parametri

Parametro Tipo Descrizione
nome corda Il nome della variabile di ambiente da utilizzare per caricare il parametro.
opzioni ParamOptions <booleano> Opzioni di configurazione per il parametro.

Ritorna:

BooleanParam

Un parametro con un tipo restituito boolean per .value .

params.defineInt()

Dichiarare un parametro intero.

Firma:

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

Parametri

Parametro Tipo Descrizione
nome corda Il nome della variabile di ambiente da utilizzare per caricare il parametro.
opzioni ParamOptions <numero> Opzioni di configurazione per il parametro.

Ritorna:

IntParam

Un parametro con un tipo restituito number per .value .

params.defineList()

Dichiarare un parametro di lista.

Firma:

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

Parametri

Parametro Tipo Descrizione
nome corda Il nome della variabile di ambiente da utilizzare per caricare il parametro.
opzioni ParamOptions <string[]> Opzioni di configurazione per il parametro.

Ritorna:

ListParam

Un parametro con un tipo restituito string[] per .value .

params.defineSecret()

Dichiara un parametro segreto, che manterrà i valori solo in Cloud Secret Manager. I segreti vengono archiviati internamente come stringhe di byte. Utilizzare ParamOptions.as per fornire suggerimenti sul tipo durante la risoluzione dei parametri.

Firma:

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

Parametri

Parametro Tipo Descrizione
nome corda Il nome della variabile di ambiente da utilizzare per caricare il parametro.

Ritorna:

SecretParam

Un parametro con un tipo restituito string per .value .

params.defineString()

Dichiarare un parametro stringa.

Firma:

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

Parametri

Parametro Tipo Descrizione
nome corda Il nome della variabile di ambiente da utilizzare per caricare il parametro.
opzioni ParamOptions <stringa> Opzioni di configurazione per il parametro.

Ritorna:

StringParam

Un parametro con un tipo restituito string per .value .

params.multiSelect()

Crea un input a selezione multipla da una serie di valori.

Firma:

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

Parametri

Parametro Tipo Descrizione
opzioni corda[]

Ritorna:

Ingresso a selezione multipla

params.multiSelect()

Crea un input a selezione multipla dalla mappa delle etichette ai valori.

Firma:

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

Parametri

Parametro Tipo Descrizione
opzioni Registra<stringa, stringa>

Ritorna:

Ingresso a selezione multipla

parametri.select()

Crea un input selezionato da una serie di valori.

Firma:

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

Parametri

Parametro Tipo Descrizione
opzioni T[]

Ritorna:

Seleziona Ingresso <T>

parametri.select()

Crea un input selezionato da una mappa di etichette a valori.

Firma:

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

Parametri

Parametro Tipo Descrizione
opzioniConEtichette Registra<stringa, T>

Ritorna:

Seleziona Ingresso <T>

params.BUCKET_PICKER

Genera automaticamente un elenco di bucket in un progetto da cui un utente può selezionare.

Firma:

BUCKET_PICKER: ResourceInput

params.databaseURL

Un parametro integrato che si risolve nell'URL del database RTDB predefinito associato al progetto, senza richiedere conferma al distributore. Stringa vuota se non esiste.

Firma:

databaseURL: Param<string>

params.declaredParams

Firma:

declaredParams: SecretOrExpr[]

params.gcloudProject

Un parametro integrato che si risolve nell'ID del progetto cloud, senza richiedere conferma al distributore.

Firma:

gcloudProject: Param<string>

params.IDprogetto

Un parametro integrato che si risolve nell'ID progetto cloud associato al progetto, senza richiedere conferma al distributore.

Firma:

projectID: Param<string>

params.storageBucket

Un parametro integrato che si risolve nel bucket di archiviazione cloud associato alla funzione, senza richiedere conferma al distributore. Stringa vuota se non definita.

Firma:

storageBucket: Param<string>

params.ParamOptions

Opzioni di configurazione che possono essere utilizzate per personalizzare il comportamento di richiesta di un parametro.

Firma:

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