हस्ताक्षर:
export declare class FunctionBuilder
कंस्ट्रक्टर्स
निर्माता | संशोधक | विवरण |
---|---|---|
(निर्माता)(विकल्प) | FunctionBuilder वर्ग का एक नया उदाहरण बनाता है |
गुण
संपत्ति | संशोधक | प्रकार | विवरण |
---|---|---|---|
एनालिटिक्स | {घटना: (एनालिटिक्सइवेंटटाइप: स्ट्रिंग) => एनालिटिक्स.एनालिटिक्सइवेंटबिल्डर ; } | ||
प्रमाणन | { उपयोगकर्ता: (उपयोगकर्ता विकल्प?: auth.UserOptions ) => auth.UserBuilder ; } | ||
डेटाबेस | {उदाहरण: (उदाहरण: स्ट्रिंग) => डेटाबेस.इंस्टेंसबिल्डर ; रेफरी: <रेफ स्ट्रिंग का विस्तार करता है>(पथ: रेफरी) => डेटाबेस.RefBuilder <संदर्भ>; } | ||
इस firestore | {दस्तावेज़: <पथ स्ट्रिंग का विस्तार करता है>(पथ: पथ) => firestore.DocumentBuilder <पथ>; नेमस्पेस: (नेमस्पेस: स्ट्रिंग) => फायरस्टोर.नेमस्पेसबिल्डर ; डेटाबेस: (डेटाबेस: स्ट्रिंग) => फायरस्टोर.डेटाबेसबिल्डर ; } | ||
HTTPS के | { onRequest: (हैंडलर: (req: https.Request, resp: Express.Response) => void | Promise<void>) => आयात("।/cloud-functions")। HTTPSफ़ंक्शन ; ऑनकॉल: (हैंडलर: (डेटा: कोई भी, संदर्भ: https.CallableContext ) => कोई भी | वादा<कोई भी>) => आयात("।/क्लाउड-फंक्शन")। Httpsफ़ंक्शन और आयात(''/क्लाउड-फ़ंक्शंस'')। चलाने योग्य <कोई भी>; } | ||
पबसब | {विषय: (विषय: स्ट्रिंग) => पबसब.टॉपिकबिल्डर ; शेड्यूल: (शेड्यूल: स्ट्रिंग) => पबसब.शेड्यूलबिल्डर ; } | ||
रिमोट कॉन्फिग | {ऑनअपडेट: (हैंडलर: (संस्करण: रिमोटकॉन्फिग.टेम्पलेटवर्जन , संदर्भ: इवेंट कॉन्टेक्स्ट ) => प्रॉमिस लाइक<कोई भी> | कोई भी) => आयात("।/क्लाउड-फ़ंक्शंस")। क्लाउडफ़ंक्शन < रिमोटकॉन्फिग.टेम्पलेटवर्जन >; } | ||
भंडारण | { बाल्टी: (बाल्टी?: स्ट्रिंग) => स्टोरेज.बकेटबिल्डर ; ऑब्जेक्ट: () => स्टोरेज.ऑब्जेक्टबिल्डर ; } | ||
कार्य | {टास्कक्यू: (विकल्प?: कार्य.टास्कक्यूऑप्शन ) => कार्य.टास्कक्यूबिल्डर ; } | ||
टेस्टलैब | { टेस्टमैट्रिक्स: () => टेस्टलैब.टेस्टमैट्रिक्सबिल्डर ; } |
तरीकों
तरीका | संशोधक | विवरण |
---|---|---|
क्षेत्र(क्षेत्र) | उन क्षेत्रों को कॉन्फ़िगर करें जहां फ़ंक्शन तैनात किया गया है। | |
रनविथ(रनटाइम विकल्प) | फ़ंक्शन के लिए रनटाइम विकल्प कॉन्फ़िगर करें. |
फंक्शनबिल्डर.(निर्माता)
FunctionBuilder
वर्ग का एक नया उदाहरण बनाता है
हस्ताक्षर:
constructor(options: DeploymentOptions);
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
विकल्प | परिनियोजन विकल्प |
फंक्शनबिल्डर.एनालिटिक्स
हस्ताक्षर:
get analytics(): {
event: (analyticsEventType: string) => analytics.AnalyticsEventBuilder;
};
FunctionBuilder.auth
हस्ताक्षर:
get auth(): {
user: (userOptions?: auth.UserOptions) => auth.UserBuilder;
};
FunctionBuilder.डेटाबेस
हस्ताक्षर:
get database(): {
instance: (instance: string) => database.InstanceBuilder;
ref: <Ref extends string>(path: Ref) => database.RefBuilder<Ref>;
};
फंक्शनबिल्डर.फ़ायरस्टोर
हस्ताक्षर:
get firestore(): {
document: <Path extends string>(path: Path) => firestore.DocumentBuilder<Path>;
namespace: (namespace: string) => firestore.NamespaceBuilder;
database: (database: string) => firestore.DatabaseBuilder;
};
FunctionBuilder.https
हस्ताक्षर:
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>;
};
फंक्शनबिल्डर.पबसब
हस्ताक्षर:
get pubsub(): {
topic: (topic: string) => pubsub.TopicBuilder;
schedule: (schedule: string) => pubsub.ScheduleBuilder;
};
FunctionBuilder.remoteConfig
हस्ताक्षर:
get remoteConfig(): {
onUpdate: (handler: (version: remoteConfig.TemplateVersion, context: EventContext) => PromiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>;
};
फंक्शनबिल्डर.भंडारण
हस्ताक्षर:
get storage(): {
bucket: (bucket?: string) => storage.BucketBuilder;
object: () => storage.ObjectBuilder;
};
FunctionBuilder.कार्य
हस्ताक्षर:
get tasks(): {
taskQueue: (options?: tasks.TaskQueueOptions) => tasks.TaskQueueBuilder;
};
फंक्शनबिल्डर.टेस्टलैब
हस्ताक्षर:
get testLab(): {
testMatrix: () => testLab.TestMatrixBuilder;
};
फंक्शनबिल्डर.क्षेत्र()
उन क्षेत्रों को कॉन्फ़िगर करें जहां फ़ंक्शन तैनात किया गया है।
हस्ताक्षर:
region(...regions: Array<(typeof SUPPORTED_REGIONS)[number] | string | Expression<string> | ResetValue>): FunctionBuilder;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
क्षेत्रों | सारणी<( SUPPORTED_REGIONS का प्रकार )[संख्या] | स्ट्रिंग | अभिव्यक्ति <स्ट्रिंग> | रीसेटवैल्यू> | एक या अधिक क्षेत्र स्ट्रिंग. |
रिटर्न:
उदाहरण 1
फ़ंक्शन.क्षेत्र('us-east1')
उदाहरण 2
function.region('us-east1', 'us-central1')
FunctionBuilder.runWith()
फ़ंक्शन के लिए रनटाइम विकल्प कॉन्फ़िगर करें.
हस्ताक्षर:
runWith(runtimeOptions: RuntimeOptions): FunctionBuilder;
पैरामीटर
पैरामीटर | प्रकार | विवरण |
---|---|---|
रनटाइम विकल्प | रनटाइम विकल्प | वैकल्पिक फ़ील्ड के साथ ऑब्जेक्ट: 1. memory : फ़ंक्शन को आवंटित करने के लिए मेमोरी की मात्रा, संभावित मान हैं: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB', और '8GB' . 2. timeoutSeconds : सेकंड में फ़ंक्शन के लिए टाइमआउट, संभावित मान 0 से 540 हैं। 3. failurePolicy : फ़ंक्शन की विफलता नीति, बूलियन true एक खाली पुनः प्रयास ऑब्जेक्ट प्रदान करने के बराबर है। 4. vpcConnector : एक ही प्रोजेक्ट और क्षेत्र में एक VPC कनेक्टर की आईडी 5. vpcConnectorEgressSettings : जब एक vpcConnector सेट किया जाता है, तो नियंत्रित करें कि vpcConnector के माध्यम से कौन सा निकास ट्रैफ़िक भेजा जाता है। मान शून्य नहीं होना चाहिए. |
रिटर्न: