FunctionBuilder class

Assinatura:

export declare class FunctionBuilder

Construtores

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

Propriedades

Propriedade Modificadores Tipo Descrição
análise { event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder }
autenticação { user: (userOptions?: auth.UserOptions) => auth.UserBuilder }
database { instance: (instance: string) => database.InstanceBuilder ref: <Ref extensions string>(path: Ref) => database.RefBuilder<Ref>; }
firestore { document: <Caminho estende string>(caminho: Caminho) => firestore.DocumentBuilder<Path>; namespace: (namespace: string) => firestore.NamespaceBuilder (em inglês) banco de dados: (banco de dados: string) => firestore.DatabaseBuilder }
https { onRequest: (handler: (req: https.Request, resp: express.Response) => void | Commit<void>) => import("./cloud-functions").HttpsFunction; onCall: (handler: (data: any, context: https.CallableContext) => any | Commit<any>) => import("./cloud-functions").HttpsFunction e import("./cloud-functions").Executável<any>; }
pubsub { topic: (topic: string) => pubsub.TopicBuilder programação: (programação: string) => pubsub.ScheduleBuilder }
remoteConfig (em inglês) { onUpdate: (handler: (versão: remoteConfig.TemplateVersion, contexto: EventContext) => promiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>; }
armazenamento { bucket: (bucket?: string) => storage.BucketBuilder objeto: () => storage.ObjectBuilder }
tarefas { taskQueue: (opções?: tasks.TaskQueueOptions) => tasks.TaskQueueBuilder; }
testLab (link em inglês) { matriz de teste: () => testLab.TestMatrixBuilder; }

Métodos

Método Modificadores Descrição
region(regions) Configure as regiões em que a função é implantada.
runWith(runtimeOptions) (em inglês) Configurar opções de ambiente de execução para a função.

FunctionBuilder.(construtor)

Cria uma nova instância da classe FunctionBuilder

Assinatura:

constructor(options: DeploymentOptions);

Parâmetros

Parâmetro Tipo Descrição
options DeploymentOptions (em inglês)

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 em que a função é 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)[number] | string | Expressão<string> | RedefinirValue> Uma ou mais strings de região.

Retorna:

FunctionBuilder (link em inglês)

Exemplo 1

functions.region('us-east1')

Exemplo 2

functions.region('us-east1', 'us-central1')

FunctionBuilder.runWith()

Configurar opções de ambiente de execução para a função.

Assinatura:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Parâmetros

Parâmetro Tipo Descrição
ambiente de execução RuntimeOptions (em inglês) Objeto com campos opcionais: 1. memory: quantidade de memória a ser alocada para a função. Os valores possíveis são "128 MB", "256 MB", "512 MB", "1 GB", "2 GB", "4 GB" e "8 GB". 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, com o booleano true sendo equivalente a fornecer um objeto de repetição vazio. 4. vpcConnector: ID de um conector de VPC no mesmo projeto e região 5. vpcConnectorEgressSettings: quando um vpcConnector for definido, controle qual tráfego de saída é enviado pela vpcConnector.O valor não pode ser nulo.

Retorna:

FunctionBuilder (link em inglês)