Funciones
| Función | Descripción |
|---|---|
| DefineBoolean (nombre, opciones) | Declarar un parámetro booleano. |
| DefineInt (nombre, opciones) | Declarar un parámetro entero. |
| definitivamente (nombre, opciones) | Declarar un parámetro de lista. |
| DefinesSecret (nombre) | Declara un parámetro secreto, que persistirá solo en los valores de Cloud Secret Manager. Los secretos se almacenan internamente como bytestrings. Use ParamOptions.as para proporcionar sugerencias de tipo durante la resolución de parámetros. |
| definir (nombre, opciones) | Declarar un parámetro de cadena. |
| multiselecto (opciones) | Cree una entrada multiselección de una serie de valores. |
| multiselecto (opciones) | Cree una entrada multiselección del mapa de etiquetas a valores. |
| Seleccione opciones) | Cree una entrada seleccionada de una serie de valores. |
| Seleccione (opción SwithLabels) | Cree una entrada seleccionada de un mapa de etiquetas a valores. |
Clases
| Clase | Descripción |
|---|---|
| Expresión |
Interfaces
| Interfaz | Descripción |
|---|---|
| Múltiples múltiples | Especifica que el valor de un parámetro debe determinarse al hacer que el usuario seleccione un subconjunto de una lista de opciones previas a la medida interactiva en el tiempo de implementación. Dará como resultado errores si se usan en parámetros de tipo que no sean string[] . |
| SelectInput | Especifica que el valor de un parámetro debe determinarse haciendo que el usuario seleccione de una lista de opciones precaneadas de manera interactiva en el tiempo de implementación. |
| Seleccione opciones | Una de las opciones proporcionadas a un SelectInput , que contiene un valor y, opcionalmente, una etiqueta legible por humanos para mostrar en la interfaz de selección. |
| Entrada de texto | Especifica que el valor de un parámetro debe determinarse al solicitar al usuario que lo escriba de manera interactiva en el tiempo de implementación. La entrada que no coincide con la validación proporcionada, si está presente, se volverá a jugar. |
variables
| Variable | Descripción |
|---|---|
| Bucket_picker | Autogenere una lista de cubos en un proyecto que un usuario puede seleccionar. |
| base de datos | Un parámetro incorporado que se resuelve con la URL de base de datos RTDB predeterminada asociada con el proyecto, sin solicitar al implementador. Cadena vacía si no existe ninguna. |
| paramentos declarados | |
| gcloudproject | Un parámetro incorporado que se resuelve con la ID del proyecto en la nube, sin solicitar al implementador. |
| Projecto ID | Un parámetro incorporado que se resuelve con la ID del proyecto en la nube asociada con el proyecto, sin solicitar al implementador. |
| StorageBucket | Un parámetro integrado que se resuelve con el cubo de almacenamiento en la nube asociado con la función, sin solicitar al implementador. Cadena vacía si no se define. |
Tipo de alias
| Tipo Alias | Descripción |
|---|---|
| Paramasiones | Opciones de configuración que se pueden utilizar para personalizar el comportamiento de solicitud de un parámetro. |
params.defineBoolean ()
Declarar un parámetro booleano.
Firma:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | cadena | El nombre de la variable de entorno para usar para cargar el parámetro. |
| opciones | Paramasiones <booleano> | Opciones de configuración para el parámetro. |
Devoluciones:
parámetro booleano
Un parámetro con un tipo de retorno boolean para .value .
params.defineInt ()
Declarar un parámetro entero.
Firma:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | cadena | El nombre de la variable de entorno para usar para cargar el parámetro. |
| opciones | Paramasiones <número> | Opciones de configuración para el parámetro. |
Devoluciones:
IntParam
Un parámetro con un tipo de retorno number para .value .
params.defineList ()
Declarar un parámetro de lista.
Firma:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | cadena | El nombre de la variable de entorno para usar para cargar el parámetro. |
| opciones | Paramasiones <cadena[]> | Opciones de configuración para el parámetro. |
Devoluciones:
Listparam
Un parámetro con un tipo de retorno string[] para .value .
params.definesecret ()
Declara un parámetro secreto, que persistirá solo en los valores de Cloud Secret Manager. Los secretos se almacenan internamente como bytestrings. Use 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 | cadena | El nombre de la variable de entorno para usar para cargar el parámetro. |
Devoluciones:
Secretparam
Un parámetro con un tipo de retorno string para .value .
params.definestring ()
Declarar un parámetro de cadena.
Firma:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | cadena | El nombre de la variable de entorno para usar para cargar el parámetro. |
| opciones | Paramasiones <cadena> | Opciones de configuración para el parámetro. |
Devoluciones:
Stringparam
Un parámetro con un tipo de retorno string para .value .
params.multiselect ()
Cree una entrada multiselección de una serie de valores.
Firma:
export declare function multiSelect(options: string[]): MultiSelectInput;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| opciones | cadena[] |
Devoluciones:
params.multiselect ()
Cree una entrada multiselección del mapa de etiquetas a valores.
Firma:
export declare function multiSelect(options: Record<string, string>): MultiSelectInput;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| opciones | Grabar<cadena,cadena> |
Devoluciones:
params.select ()
Cree una entrada seleccionada de una serie de valores.
Firma:
export declare function select<T>(options: T[]): SelectInput<T>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| opciones | T[] |
Devoluciones:
SelectInput <t>
params.select ()
Cree una entrada seleccionada 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 |
|---|---|---|
| opción | Registro <String, t> |
Devoluciones:
SelectInput <t>
params.bucket_picker
Autogenere una lista de cubos en un proyecto que un usuario puede seleccionar.
Firma:
BUCKET_PICKER: ResourceInput
params.databaseurl
Un parámetro incorporado que se resuelve con la URL de base de datos RTDB predeterminada asociada con el proyecto, sin solicitar al implementador. Cadena vacía si no existe ninguna.
Firma:
databaseURL: Param<string>
params.declaredParams
Firma:
declaredParams: SecretOrExpr[]
params.gcloudproject
Un parámetro incorporado que se resuelve con la ID del proyecto en la nube, sin solicitar al implementador.
Firma:
gcloudProject: Param<string>
params.projectid
Un parámetro incorporado que se resuelve con la ID del proyecto en la nube asociada con el proyecto, sin solicitar al implementador.
Firma:
projectID: Param<string>
params.storageBucket
Un parámetro integrado que se resuelve con el cubo de almacenamiento en la nube asociado con la función, sin solicitar al implementador. Cadena vacía si no se define.
Firma:
storageBucket: Param<string>
params.paramoptions
Opciones de configuración que se pueden utilizar para personalizar el comportamiento de solicitud de un parámetro.
Firma:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;