FunctionBuilder class

Firma:

export declare class FunctionBuilder

Costruttori

Costruttore Modificatori Descrizione
(costruttore)(opzioni) Costruisce una nuova istanza della classe FunctionBuilder

Proprietà

Proprietà Modificatori Tipo Descrizione
analitica { evento: (analyticsEventType: string) => analytics.AnalyticsEventBuilder ; }
aut { utente: (opzioniutente?: auth.Opzioniutente ) => aut.UserBuilder ; }
Banca dati { istanza: (istanza: stringa) => database.InstanceBuilder ; ref: <Ref estende la stringa>(percorso: Ref) => database.RefBuilder <Rif>; }
fuoco { documento: <Percorso estende stringa>(percorso: Percorso) => firestore.DocumentBuilder <Percorso>; namespace: (namespace: stringa) => firestore.NamespaceBuilder ; database: (database: stringa) => firestore.DatabaseBuilder ; }
https { onRequest: (handler: (req: https.Request, resp: express.Response) => void | Promise<void>) => import("./cloud-functions"). Funzione Https ; onCall: (gestore: (dati: qualsiasi, contesto: https.CallableContext ) => qualsiasi | Promessa<qualsiasi>) => import("./cloud-functions"). HttpsFunction & import("./cloud-functions"). Percorribile <qualsiasi>; }
pubsub { argomento: (argomento: stringa) => pubsub.TopicBuilder ; pianificazione: (pianificazione: stringa) => pubsub.ScheduleBuilder ; }
remoteConfig { onUpdate: (gestore: (versione: remoteConfig.TemplateVersion , contesto: EventContext ) => PromiseLike<qualsiasi> | any) => import("./cloud-functions"). Funzione Cloud < remoteConfig.TemplateVersion >; }
magazzinaggio { bucket: (bucket?: stringa) => storage.BucketBuilder ; oggetto: () => storage.ObjectBuilder ; }
compiti { taskQueue: (opzioni?: task.TaskQueueOptions ) => attività.TaskQueueBuilder ; }
testLab { testMatrix: () => testLab.TestMatrixBuilder ; }

Metodi

Metodo Modificatori Descrizione
regione (regioni) Configurare le regioni in cui viene distribuita la funzione.
eseguiCon(opzioniruntime) Configurare le opzioni di runtime per la funzione.

FunctionBuilder.(costruttore)

Costruisce una nuova istanza della classe FunctionBuilder

Firma:

constructor(options: DeploymentOptions);

Parametri

Parametro Tipo Descrizione
opzioni Opzioni di distribuzione

FunctionBuilder.analytics

Firma:

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

FunctionBuilder.auth

Firma:

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

FunctionBuilder.database

Firma:

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

FunctionBuilder.firestore

Firma:

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

FunctionBuilder.https

Firma:

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

Firma:

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

FunctionBuilder.remoteConfig

Firma:

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

FunctionBuilder.storage

Firma:

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

FunctionBuilder.tasks

Firma:

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

FunctionBuilder.testLab

Firma:

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

FunctionBuilder.region()

Configurare le regioni in cui viene distribuita la funzione.

Firma:

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

Parametri

Parametro Tipo Descrizione
regioni Array<(tipo di SUPPORTED_REGIONS )[numero] | stringa | Espressione <stringa> | Reimpostavalore> Una o più stringhe regionali.

Ritorna:

Costruttore di funzioni

Esempio 1

funzioni.region('us-east1')

Esempio 2

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

FunctionBuilder.runWith()

Configurare le opzioni di runtime per la funzione.

Firma:

runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;

Parametri

Parametro Tipo Descrizione
runtimeOptions Opzioni di runtime Oggetto con campi facoltativi: 1. memory : quantità di memoria da allocare alla funzione, i valori possibili sono: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB' e '8GB' . 2. timeoutSeconds : timeout per la funzione in secondi, i valori possibili sono compresi tra 0 e 540. 3. failurePolicy : politica di errore della funzione, con booleano true equivalente a fornire un oggetto di tentativo vuoto. 4. vpcConnector : ID di un connettore VPC nello stesso progetto e regione 5. vpcConnectorEgressSettings : quando viene impostato un vpcConnector , controlla quale traffico in uscita viene inviato tramite vpcConnector . Il valore non deve essere nullo.

Ritorna:

Costruttore di funzioni