Se usó la API de Cloud Translation para traducir esta página.

params namespace

Funciones

Función	Descripción
defineBoolean(nombre, opciones)	Declara un parámetro booleano.
defineInt(nombre, opciones)	Declara un parámetro de número entero.
defineList(nombre, opciones)	Declara un parámetro de lista.
defineSecret(nombre)	Declara un parámetro secreto, que conservará valores solo en Cloud Secret Manager. Los Secrets se almacenan internamente como strings de bytes. Usa `ParamOptions.as` para proporcionar sugerencias de tipo durante la resolución de parámetros.
defineString(nombre, opciones)	Declara un parámetro de cadena.
multiSelect(opciones)	Crea una entrada de selección múltiple a partir de una serie de valores.
multiSelect(opciones)	Crea una entrada de selección múltiple desde la asignación de etiquetas a los valores.
select(opciones)	Crea una entrada de selección a partir de una serie de valores.
select(opcionesConEtiquetas)	Crea una entrada de selección a partir de un mapa de etiquetas a valores.

Clases

Clase	Descripción
Expresión

Interfaces

Interfaz	Descripción
MultiSelectInput	Especifica que el valor de un parámetro se debe determinar haciendo que el usuario seleccione un subconjunto de una lista de opciones preestablecidas de manera interactiva en el momento de la implementación. Se generarán errores si se usan en parámetros de tipo distinto de `string[]`.
SelectInput	Especifica que el valor de un parámetro se debe determinar haciendo que el usuario seleccione de una lista de opciones preestablecidas de manera interactiva en el momento de la implementación.
SelectOptions	Es una de las opciones proporcionadas a un objeto `SelectInput`, que contiene un valor y, opcionalmente, una etiqueta legible para que se muestre en la interfaz de selección.
TextInput	Especifica que el valor de un parámetro se debe determinar pidiéndole al usuario que lo escriba de manera interactiva en el momento de la implementación. Se volverá a intentar una entrada que no coincida con la validaciónRegex proporcionada (si está presente).

Variables

Variable	Descripción
BUCKET_PICKER	Genera automáticamente una lista de buckets de un proyecto entre los que un usuario puede seleccionar.
URLdebase_de_datos	Un parámetro integrado que se resuelve en la URL predeterminada de la base de datos RTDB asociada con el proyecto, sin preguntar al implementador. La cadena está vacía si no existe ninguna.
DeclaredParams
gcloudProject	Un parámetro integrado que se resuelve en el ID del proyecto de Cloud, sin preguntar al implementador.
ID del proyecto	Un parámetro integrado que se resuelve en el ID del proyecto de Cloud asociado con el proyecto, sin preguntar al implementador.
storageBucket	Un parámetro integrado que se resuelve en el bucket de Cloud Storage asociado con la función, sin preguntar al implementador. La cadena está vacía si no se define.

Escribe alias

Alias de tipo	Descripción
Opciones de parámetros	Son las opciones de configuración que se pueden usar para personalizar el comportamiento de los mensajes de un parámetro.

params.defineBoolean()

Declara un parámetro booleano.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
nombre	string	El nombre de la variable de entorno que se usará para cargar el parámetro.
opciones	Opciones param.<booleano>	Opciones de configuración para el parámetro.

Muestra:

BooleanParam

Un parámetro con un tipo de datos que se muestra boolean para .value.

params.defineInt().

Declara un parámetro de número entero.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
nombre	string	El nombre de la variable de entorno que se usará para cargar el parámetro.
opciones	Opciones de parámetros<number>	Opciones de configuración para el parámetro.

Muestra:

Parámetro interno

Un parámetro con un tipo de datos que se muestra number para .value.

params.defineList()

Declara un parámetro de lista.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
nombre	string	El nombre de la variable de entorno que se usará para cargar el parámetro.
opciones	Opciones<string[]>	Opciones de configuración para el parámetro.

Muestra:

Parámetro de lista

Un parámetro con un tipo de datos que se muestra string[] para .value.

params.defineSecret()

Declara un parámetro secreto, que conservará valores solo en Cloud Secret Manager. Los Secrets se almacenan internamente como strings de bytes. Usa ParamOptions.as para proporcionar sugerencias de tipo durante la resolución de parámetros.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
nombre	string	El nombre de la variable de entorno que se usará para cargar el parámetro.

Muestra:

Parámetro Secret

Un parámetro con un tipo de datos que se muestra string para .value.

params.defineString()

Declara un parámetro de cadena.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
nombre	string	El nombre de la variable de entorno que se usará para cargar el parámetro.
opciones	ParamOptions<string>	Opciones de configuración para el parámetro.

Muestra:

Parámetro de cadena

Un parámetro con un tipo de datos que se muestra string para .value.

params.multiSelect()

Crea una entrada de selección múltiple a partir de una serie de valores.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
opciones	string[]

Muestra:

MultiSelectInput

params.multiSelect()

Crea una entrada de selección múltiple desde la asignación de etiquetas a los valores.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
opciones	Registro<cadena, cadena>

Muestra:

MultiSelectInput

params.select()

Crea una entrada de selección a partir de una serie de valores.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
opciones	M

Muestra:

SelectInput<T>

params.select()

Crea una entrada de selección a partir de un mapa de etiquetas a valores.

Firma:

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

Parámetros

Parámetro	Tipo	Descripción
opcionesConEtiquetas	Grabar<string, T>

Muestra:

SelectInput<T>

params.BUCKET_PICKER

Genera automáticamente una lista de buckets en un proyecto entre los que un usuario puede seleccionar.

Firma:

BUCKET_PICKER: ResourceInput

params.databaseURL

Un parámetro integrado que se resuelve en la URL predeterminada de la base de datos RTDB asociada con el proyecto, sin preguntar al implementador. La cadena está vacía si no existe ninguna.

Firma:

databaseURL: Param<string>

params.DeclaredParams

Firma:

declaredParams: SecretOrExpr[]

params.gcloudProject

Un parámetro integrado que se resuelve en el ID del proyecto de Cloud, sin preguntar al implementador.

Firma:

gcloudProject: Param<string>

params.projectID

Un parámetro integrado que se resuelve en el ID del proyecto de Cloud asociado con el proyecto, sin preguntar al implementador.

Firma:

projectID: Param<string>

params.storageBucket

Un parámetro integrado que se resuelve en el bucket de Cloud Storage asociado con la función, sin preguntar al implementador. La cadena está vacía si no se define.

Firma:

storageBucket: Param<string>

params.ParamOptions

Son las opciones de configuración que se pueden usar para personalizar el comportamiento de los mensajes de un parámetro.

Firma:

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