Funções
| Função | Descrição |
|---|---|
| defineBoolean(name, options) | Declarar um parâmetro booleano. |
| defineInt(nome, opções) | Declare um parâmetro inteiro. |
| defineList(nome, opções) | Declarar um parâmetro de lista. |
| defineSecret(name) | Declara um parâmetro secreto que manterá os valores somente no Cloud Secret Manager. Os secrets são armazenados internamente como strings de bytes. Use ParamOptions.as para fornecer dicas de tipo durante a resolução do parâmetro. |
| defineString(name, options) | Declarar um parâmetro de string. |
| multiSelect(options) | Crie uma entrada de seleção múltipla a partir de uma série de valores. |
| multiSelect(options) | Crie uma entrada de seleção múltipla do mapa de rótulos para os valores. |
| select(options) | Cria uma entrada de seleção a partir de uma série de valores. |
| select(optionsWithLabels) | Cria uma entrada de seleção de um mapa de rótulos para valores. |
Classes
| Turma | Descrição |
|---|---|
| Expressão |
Interfaces
| Interface | Descrição |
|---|---|
| MultiSelectInput (em inglês) | Especifica que o valor de um parâmetro deve ser determinado fazendo com que o usuário selecione um subconjunto de uma lista de opções predefinidas de maneira interativa no momento da implantação. Vai resultar em erros se usado em parâmetros de tipos diferentes de string[]. |
| SelectInput (em inglês) | Especifica que o valor de um parâmetro deve ser determinado fazendo com que o usuário selecione de uma lista de opções predefinidas interativamente no momento da implantação. |
| SelectOptions (em inglês). | Uma das opções fornecidas para um SelectInput, contendo um valor e, opcionalmente, um rótulo legível para exibição na interface de seleção. |
| TextInput | Especifica que o valor de um parâmetro deve ser determinado solicitando que o usuário o digite interativamente no momento da implantação. A entrada que não corresponde ao validateRegex fornecido, se presente, será repetida. |
Variáveis
| Variável | Descrição |
|---|---|
| PICKER DE BUCKET | Gerar automaticamente uma lista de buckets em um projeto que um usuário pode selecionar. |
| databaseURL (link em inglês) | Um parâmetro integrado que é resolvido para o URL padrão do banco de dados do RTDB associado ao projeto, sem notificar o implantador. String vazia se nenhuma existir. |
| declaredParams. | |
| gcloudProject (em inglês) | Um parâmetro integrado que é resolvido para o ID do projeto do Cloud sem solicitar ao implantador. |
| ID do projeto | Um parâmetro integrado que é resolvido para o ID do projeto do Cloud associado ao projeto, sem notificar o implantador. |
| storageBucket | Um parâmetro integrado que é resolvido para o bucket do Cloud Storage associado à função, sem solicitar ao implantador. String vazia se não tiver sido definida. |
Aliases de tipos
| Alias de tipo | Descrição |
|---|---|
| ParamOptions (em inglês) | Opções de configuração que podem ser usadas para personalizar o comportamento de solicitação de um parâmetro. |
params.defineBoolean()
Declarar um parâmetro booleano.
Assinatura:
export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| name | string | O nome da variável de ambiente a ser usada para carregar o parâmetro. |
| options | ParamOptions<boolean> | Opções de configuração para o parâmetro. |
Retorna:
Parâmetro booleano
Um parâmetro com um tipo de retorno boolean para .value.
params.defineInt()
Declare um parâmetro inteiro.
Assinatura:
export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| name | string | O nome da variável de ambiente a ser usada para carregar o parâmetro. |
| options | Opções do parâmetro<number> | Opções de configuração para o parâmetro. |
Retorna:
IntParam
Um parâmetro com um tipo de retorno number para .value.
params.defineList()
Declarar um parâmetro de lista.
Assinatura:
export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| name | string | O nome da variável de ambiente a ser usada para carregar o parâmetro. |
| options | Opções de parâmetro<string[]> | Opções de configuração para o parâmetro. |
Retorna:
Parâmetro de lista
Um parâmetro com um tipo de retorno string[] para .value.
params.defineSecret()
Declara um parâmetro secreto que manterá os valores somente no Cloud Secret Manager. Os secrets são armazenados internamente como strings de bytes. Use ParamOptions.as para fornecer dicas de tipo durante a resolução do parâmetro.
Assinatura:
export declare function defineSecret(name: string): SecretParam;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| name | string | O nome da variável de ambiente a ser usada para carregar o parâmetro. |
Retorna:
Param secreto
Um parâmetro com um tipo de retorno string para .value.
params.defineString()
Declarar um parâmetro de string.
Assinatura:
export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| name | string | O nome da variável de ambiente a ser usada para carregar o parâmetro. |
| options | Opções de parâmetro<string> | Opções de configuração para o parâmetro. |
Retorna:
Parâmetro String
Um parâmetro com um tipo de retorno string para .value.
params.multiSelect()
Crie uma entrada de seleção múltipla a partir de uma série de valores.
Assinatura:
export declare function multiSelect(options: string[]): MultiSelectInput;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| options | string[] |
Retorna:
MultiSelectInput (em inglês)
params.multiSelect()
Crie uma entrada de seleção múltipla do mapa de rótulos para os valores.
Assinatura:
export declare function multiSelect(options: Record<string, string>): MultiSelectInput;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| options | Record<string, string> |
Retorna:
MultiSelectInput (em inglês)
params.select()
Cria uma entrada de seleção a partir de uma série de valores.
Assinatura:
export declare function select<T>(options: T[]): SelectInput<T>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| options | T[] |
Retorna:
SelectInput<T>
params.select()
Cria uma entrada de seleção de um mapa de rótulos para valores.
Assinatura:
export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| optionsWithRótulos | Registro<string, T> |
Retorna:
SelectInput<T>
params.BUCKET_PICKER
Gerar automaticamente uma lista de buckets em um projeto que um usuário pode selecionar.
Assinatura:
BUCKET_PICKER: ResourceInput
params.databaseURL
Um parâmetro integrado que é resolvido para o URL padrão do banco de dados do RTDB associado ao projeto, sem notificar o implantador. String vazia se nenhuma existir.
Assinatura:
databaseURL: Param<string>
params.declaredParams
Assinatura:
declaredParams: SecretOrExpr[]
parâmetros.gcloudProject
Um parâmetro integrado que é resolvido para o ID do projeto do Cloud sem solicitar ao implantador.
Assinatura:
gcloudProject: Param<string>
parâmetros.projectID
Um parâmetro integrado que se refere ao ID do projeto do Cloud associado ao projeto, sem enviar uma solicitação ao implantador.
Assinatura:
projectID: Param<string>
params.storageBucket
Um parâmetro integrado que é resolvido para o bucket do Cloud Storage associado à função, sem solicitar ao implantador. String vazia se não tiver sido definida.
Assinatura:
storageBucket: Param<string>
params.ParamOptions
Opções de configuração que podem ser usadas para personalizar o comportamento de solicitação de um parâmetro.
Assinatura:
export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;