https.HttpsOptions interface

Opções que podem ser definidas em uma função HTTPS onRequest.

Assinatura:

export interface HttpsOptions extends Omit<GlobalOptions, "region"> 

Estende: Omitir< GlobalOptions , "região">

Propriedades

Propriedade Tipo Descrição
simultaneidade número | Expressão <número> | Redefinir valor Número de solicitações que uma função pode atender de uma só vez.
corpo corda | booleano | ExpReg | Matriz<string | ExpReg> Se for verdade, permite CORS em solicitações para esta função. Se for uma string ou RegExp , permite solicitações de domínios que correspondam ao valor fornecido. Se for um Array , permite solicitações de domínios que correspondam a pelo menos uma entrada do array. O padrão é verdadeiro para https.CallableFunction e falso caso contrário.
CPU número | "gcf_gen1" Número fracionário de CPUs a serem alocadas para uma função.
configurações de ingresso opções.IngressSetting | Redefinir valor Configurações de entrada que controlam de onde esta função pode ser chamada.
invocador "público" | "privado" | corda | corda[] Invoker para definir o controle de acesso em funções https.
rótulos Registro<string, string> Rótulos de usuário para definir a função.
maxInstâncias número | Expressão <número> | Redefinir valor Número máximo de instâncias a serem executadas em paralelo.
memória opções.MemoryOption | Expressão <número> | Redefinir valor Quantidade de memória a ser alocada para uma função.
minInstâncias número | Expressão <número> | Redefinir valor Número mínimo de instâncias reais em execução em um determinado momento.
omitir booleano | Expressão <booleano> Se for verdade, não implemente ou emule esta função.
região Região suportada | corda | Matriz< Região Suportada | string> | Expressão <string> | Redefinir valor As funções HTTP podem substituir opções globais e especificar diversas regiões para implantação.
segredos (string | SecretParam)[]
conta de serviço corda | Expressão <string> | Redefinir valor Conta de serviço específica para a função ser executada.
tempo limiteSegundos número | Expressão <número> | Redefinir valor Tempo limite para a função em segundos, os valores possíveis são de 0 a 540. As funções HTTPS podem especificar um tempo limite maior.
vpcConnector corda | Expressão <string> | Redefinir valor Conecte a função de nuvem ao conector VPC especificado.
vpcConnectorEgressSettings opções.VpcEgressSetting | Redefinir valor Configurações de saída para conector VPC.

https.HttpsOptions.concurrency

Número de solicitações que uma função pode atender de uma só vez.

Só pode ser aplicado a funções em execução no Cloud Functions v2. Um valor nulo restaura a simultaneidade padrão (80 quando CPU > = 1, 1 caso contrário). A simultaneidade não pode ser definida com nenhum valor diferente de 1 se cpu for menor que 1. O valor máximo para simultaneidade é 1.000.

Assinatura:

concurrency?: number | Expression<number> | ResetValue;

https.HttpsOptions.cors

Se for verdade, permite CORS em solicitações para esta função. Se for uma string ou RegExp , permite solicitações de domínios que correspondem ao valor fornecido. Se este for um Array , permite solicitações de domínios que correspondem a pelo menos uma entrada da matriz. O padrão é verdadeiro para https.CallableFunction e falso caso contrário.

Assinatura:

cors?: string | boolean | RegExp | Array<string | RegExp>;

https.HttpsOptions.cpu

Número fracionário de CPUs a serem alocadas para uma função.

O padrão é 1 para funções com < = 2 GB de RAM e aumenta para tamanhos de memória maiores. Isso é diferente dos padrões ao usar o utilitário gcloud e é diferente do valor fixo atribuído na geração 1 do Google Cloud Functions. Para reverter para os valores de CPU usados ​​no gcloud ou na geração 1 do Cloud Functions, defina-o como o valor "gcf_gen1"

Assinatura:

cpu?: number | "gcf_gen1";

https.HttpsOptions.ingressSettings

Configurações de entrada que controlam de onde esta função pode ser chamada.

Assinatura:

ingressSettings?: options.IngressSetting | ResetValue;

https.HttpsOptions.invoker

Invoker para definir o controle de acesso em funções https.

Assinatura:

invoker?: "public" | "private" | string | string[];

https.HttpsOptions.labels

Rótulos de usuário para definir a função.

Assinatura:

labels?: Record<string, string>;

https.HttpsOptions.maxInstances

Número máximo de instâncias a serem executadas em paralelo.

Assinatura:

maxInstances?: number | Expression<number> | ResetValue;

https.HttpsOptions.memory

Quantidade de memória a ser alocada para uma função.

Assinatura:

memory?: options.MemoryOption | Expression<number> | ResetValue;

https.HttpsOptions.minInstances

Número mínimo de instâncias reais em execução em um determinado momento.

As instâncias serão cobradas pela alocação de memória e 10% da alocação de CPU enquanto estiverem ociosas.

Assinatura:

minInstances?: number | Expression<number> | ResetValue;

https.HttpsOptions.omit

Se for verdade, não implemente ou emule esta função.

Assinatura:

omit?: boolean | Expression<boolean>;

https.HttpsOptions.region

As funções HTTP podem substituir opções globais e especificar diversas regiões para implantação.

Assinatura:

region?: SupportedRegion | string | Array<SupportedRegion | string> | Expression<string> | ResetValue;

https.HttpsOptions.secrets

Assinatura:

secrets?: (string | SecretParam)[];

https.HttpsOptions.serviceAccount

Conta de serviço específica para a função ser executada.

Assinatura:

serviceAccount?: string | Expression<string> | ResetValue;

https.HttpsOptions.timeoutSeconds

Tempo limite para a função em segundos, os valores possíveis são de 0 a 540. As funções HTTPS podem especificar um tempo limite maior.

O tempo limite mínimo para uma função de geração 2 é 1s. O tempo limite máximo para uma função depende do tipo de função: As funções de tratamento de eventos têm um tempo limite máximo de 540s (9 minutos). HTTPS e funções que podem ser chamadas têm um tempo limite máximo de 36,00s (1 hora). As funções de fila de tarefas têm um tempo limite máximo de 1.800 segundos (30 minutos)

Assinatura:

timeoutSeconds?: number | Expression<number> | ResetValue;

https.HttpsOptions.vpcConnector

Conecte a função de nuvem ao conector VPC especificado.

Assinatura:

vpcConnector?: string | Expression<string> | ResetValue;

https.HttpsOptions.vpcConnectorEgressSettings

Configurações de saída para conector VPC.

Assinatura:

vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;