FunctionBuilder class

Assinatura:

export declare class FunctionBuilder

Construtores

Construtor Modificadores Descrição
(construtor)(opções) Constrói uma nova instância da classe FunctionBuilder

Propriedades

Propriedade Modificadores Tipo Descrição
análise {evento: (analyticsEventType: string) => analytics.AnalyticsEventBuilder ; }
autenticação {usuário: (userOptions?: auth.UserOptions ) => auth.UserBuilder ; }
base de dados {instância: (instância: string) => banco de dados.InstanceBuilder ; ref: <Ref estende string>(caminho: Ref) => banco de dados.RefBuilder <Ref>; }
firestore {document: <Caminho estende string>(caminho: Caminho) => firestore.DocumentBuilder <Caminho>; namespace: (namespace: string) => firestore.NamespaceBuilder ; banco de dados: (banco de dados: string) => firestore.DatabaseBuilder ; }
https { onRequest: (manipulador: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions"). Função HTTPS ; onCall: (manipulador: (dados: qualquer, contexto: https.CallableContext ) => qualquer | Promessa<qualquer>) => importar("./cloud-functions"). HttpsFunction & import("./cloud-functions"). Executável <qualquer>; }
pubsub {tópico: (tópico: string) => pubsub.TopicBuilder ; agendamento: (agenda: string) => pubsub.ScheduleBuilder ; }
configuração remota { onUpdate: (manipulador: (versão: remoteConfig.TemplateVersion , contexto: EventContext ) => PromiseLike<qualquer> | qualquer) => importar("./cloud-functions"). Função Cloud < remoteConfig.TemplateVersion >; }
armazenar {balde: (balde ?: string) => armazenamento.BucketBuilder ; objeto: () => armazenamento.ObjectBuilder ; }
tarefas { taskQueue: (opções ?: tarefas.TaskQueueOptions ) => tarefas.TaskQueueBuilder ; }
laboratório de testes { testMatrix: () => testLab.TestMatrixBuilder ; }

Métodos

Método Modificadores Descrição
região(regiões) Configure as regiões nas quais a função está implantada.
runWith(runtimeOptions) Configure opções de tempo de execução para a função.

FunctionBuilder.(construtor)

Constrói uma nova instância da classe FunctionBuilder

Assinatura:

constructor(options: DeploymentOptions);

Parâmetros

Parâmetro Tipo Descrição
opções Opções de implantação

FunctionBuilder.analytics

Assinatura:

get analytics(): {
        event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder;
    };

FunctionBuilder.auth

Assinatura:

get auth(): {
        user: (userOptions?: auth.UserOptions) => auth.UserBuilder;
    };

FunctionBuilder.database

Assinatura:

get database(): {
        instance: (instance: string) => database.InstanceBuilder;
        ref: <Ref extends string>(path: Ref) => database.RefBuilder<Ref>;
    };

FunctionBuilder.firestore

Assinatura:

get firestore(): {
        document: <Path extends string>(path: Path) => firestore.DocumentBuilder<Path>;
        namespace: (namespace: string) => firestore.NamespaceBuilder;
        database: (database: string) => firestore.DatabaseBuilder;
    };

FunctionBuilder.https

Assinatura:

get https(): {
        onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions").HttpsFunction;
        onCall: (handler: (data: any, context: https.CallableContext) => any | Promise<any>) => import("./cloud-functions").HttpsFunction & import("./cloud-functions").Runnable<any>;
    };

FunctionBuilder.pubsub

Assinatura:

get pubsub(): {
        topic: (topic: string) => pubsub.TopicBuilder;
        schedule: (schedule: string) => pubsub.ScheduleBuilder;
    };

FunctionBuilder.remoteConfig

Assinatura:

get remoteConfig(): {
        onUpdate: (handler: (version: remoteConfig.TemplateVersion, context: EventContext) => PromiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>;
    };

FunctionBuilder.storage

Assinatura:

get storage(): {
        bucket: (bucket?: string) => storage.BucketBuilder;
        object: () => storage.ObjectBuilder;
    };

FunctionBuilder.tasks

Assinatura:

get tasks(): {
        taskQueue: (options?: tasks.TaskQueueOptions) => tasks.TaskQueueBuilder;
    };

FunctionBuilder.testLab

Assinatura:

get testLab(): {
        testMatrix: () => testLab.TestMatrixBuilder;
    };

FunctionBuilder.region()

Configure as regiões nas quais a função está implantada.

Assinatura:

region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;

Parâmetros

Parâmetro Tipo Descrição
regiões Matriz<(tipo de SUPPORTED_REGIONS )[número] | corda | Expressão <string> | RedefinirValor> Uma ou mais cadeias de regiões.

Retorna:

Construtor de Funções

Exemplo 1

funções.region('us-east1')

Exemplo 2

funções.region('us-east1', 'us-central1')

FunctionBuilder.runWith()

Configure opções de tempo de execução para a função.

Assinatura:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Parâmetros

Parâmetro Tipo Descrição
opções de tempo de execução Opções de tempo de execução Objeto com campos opcionais: 1. memory : quantidade de memória a ser alocada para a função, os valores possíveis são: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB' e '8GB' . 2. timeoutSeconds : tempo limite da função em segundos, os valores possíveis são de 0 a 540. 3. failurePolicy : política de falha da função, sendo booleano true equivalente a fornecer um objeto de nova tentativa vazio. 4. vpcConnector : id de um conector VPC no mesmo projeto e região 5. vpcConnectorEgressSettings : quando um vpcConnector é definido, controla qual tráfego de saída é enviado por meio do vpcConnector . O valor não deve ser nulo.

Retorna:

Construtor de Funções