RuntimeOptions interface

रनटाइम पर लागू होने वाले फ़ंक्शन के लिए कॉन्फ़िगरेशन के विकल्प.

हस्ताक्षर:

export interface RuntimeOptions 

प्रॉपर्टी

प्रॉपर्टी	टाइप	ब्यौरा
consumAppCheckToken	बूलियन	इससे यह तय होता है कि अनुरोध करने पर, Firebase ऐप्लिकेशन की जांच वाले टोकन का इस्तेमाल किया गया है या नहीं. डिफ़ॉल्ट तौर पर, 'गलत' पर सेट होती है.
enforceAppCheck	बूलियन	इससे यह पता चलता है कि Firebase AppCheck लागू किया गया है या नहीं.
failureनीति	FailurePolicy | बूलियन	फ़ंक्शन की गड़बड़ी से जुड़ी नीति, जिसमें बूलियन true, खाली फिर से कोशिश करने वाले ऑब्जेक्ट देने के बराबर है.
इन्ग्रेस डेटा ट्रैफ़िक	(INGRESS_SETTINGS_OPTIONS का टाइप)[number] | रीसेट करें	इन्ग्रेस डेटा ट्रैफ़िक की सेटिंग. इनसे यह कंट्रोल किया जाता है कि इस फ़ंक्शन को कहां से कॉल किया जा सकता है.
इनवॉइस	"सार्वजनिक" | "निजी" | स्ट्रिंग | स्ट्रिंग[]	https फ़ंक्शन पर ऐक्सेस कंट्रोल सेट करने के लिए इन्वोकर.
लेबल	रिकॉर्ड<स्ट्रिंग, स्ट्रिंग>	फ़ंक्शन पर सेट किए जाने वाले उपयोगकर्ता लेबल.
maxइंस्टेंस	नंबर | एक्सप्रेशन<number> | रीसेट करें	साथ-साथ चलने के लिए बनाए गए असल इंस्टेंस की ज़्यादा से ज़्यादा संख्या.
मेमोरी	(मान्य_MEMORY_OPTIONS का टाइप)[number] | एक्सप्रेशन<number> | रीसेट करें	फ़ंक्शन के लिए असाइन की जाने वाली मेमोरी.
minइंस्टेंस	नंबर | एक्सप्रेशन<number> | रीसेट करें	किसी दिए गए समय पर चलने वाले असल इंस्टेंस की कम से कम संख्या.
बाहरी बदलावों को सेव करें	बूलियन	यह नीति कंट्रोल करती है कि फ़ंक्शन सोर्स के बाहर बदले गए फ़ंक्शन कॉन्फ़िगरेशन को सुरक्षित रखा जाए या नहीं. डिफ़ॉल्ट तौर पर, 'गलत' पर सेट होती है.
सीक्रेट	(स्ट्रिंग | SecretParam)[]
serviceAccount	"डिफ़ॉल्ट" | स्ट्रिंग | एक्सप्रेशन<string> | रीसेट करें	फ़ंक्शन को चलाने के लिए, खास सेवा खाता.
टाइम आउटसेकंड	नंबर | एक्सप्रेशन<number> | रीसेट करें	फ़ंक्शन के लिए सेकंड में टाइम आउट हो गया, संभावित वैल्यू 0 से 540 हो सकती हैं.
vpcConnector	स्ट्रिंग | एक्सप्रेशन<string> | रीसेट करें	क्लाउड फ़ंक्शन को दिए गए VPC कनेक्टर से कनेक्ट करें.
vpcConnectorEग्रेससेटिंग	(VPC_EGRESS_SETTINGS_OPTIONS का टाइप)[number] | रीसेट करें	VPC कनेक्टर के लिए, इग्रेस डेटा ट्रैफ़िक की सेटिंग.

RuntimeOptions.consumAppCheckToken

इससे यह तय होता है कि अनुरोध करने पर, Firebase ऐप्लिकेशन की जांच वाले टोकन का इस्तेमाल किया गया है या नहीं. डिफ़ॉल्ट तौर पर, 'गलत' पर सेट होती है.

ऐप्लिकेशन की जांच फिर से चलाने की सुरक्षा की सुविधा चालू करने के लिए, इसे 'सही है' पर सेट करें. इसके लिए, कॉल करने लायक अनुरोध पर ऐप्लिकेशन की जांच वाले टोकन का इस्तेमाल करें. पहले से इस्तेमाल किए जा चुके टोकन के लिए request.app.alreadyConsumed प्रॉपर्टी, 'सही' पर सेट होगी.

टोकन का इस्तेमाल सिर्फ़ तब किया जा सकता है, जब इस विकल्प को 'सही है' पर सेट करके, उसे ऐप्लिकेशन की जांच करने वाली सेवा को भेजा गया हो. टोकन के अन्य इस्तेमाल पर उसका इस्तेमाल नहीं होता.

रीप्ले सुरक्षा की इस सुविधा के लिए, ऐप्लिकेशन चेक बैकएंड के लिए एक अतिरिक्त नेटवर्क कॉल की ज़रूरत होती है. इससे क्लाइंट, पुष्टि करने की सेवा देने वाली चुनी गई कंपनियों से नया सर्टिफ़िकेट पाने के लिए मजबूर हो जाते हैं. इसलिए, इससे परफ़ॉर्मेंस पर बुरा असर पड़ सकता है और पुष्टि करने वाली कंपनियों की संख्या कम हो सकती है कोटा तेज़ी से बढ़ता है. इस सुविधा का इस्तेमाल, कम वॉल्यूम, सुरक्षा से जुड़ी ज़रूरी बातों या महंगे कामों के लिए ही करें.

इस विकल्प से, enforceAppCheck विकल्प पर कोई असर नहीं पड़ता. बाद वाले विकल्प को 'सही' पर सेट करने से, अनुरोध में अमान्य 'ऐप्लिकेशन जांच' टोकन शामिल होने पर, कॉल करने वाला फ़ंक्शन अपने-आप 401 बिना अनुमति वाले स्टेटस कोड के साथ रिस्पॉन्स देगा. अगर किसी अनुरोध में मान्य, लेकिन इस्तेमाल किए जा चुके App Check टोकन शामिल हैं, तो अनुरोधों को अपने-आप अस्वीकार नहीं किया जाएगा. इसके बजाय, request.app.alreadyConsumed प्रॉपर्टी को 'सही' पर सेट कर दिया जाएगा और आगे के फ़ैसले लेने, जैसे कि अतिरिक्त सुरक्षा जांच की ज़रूरत पड़ने या अनुरोध को अस्वीकार करने जैसे फ़ैसले लेने के लिए, हैंडलर कोड को एक्ज़ीक्यूट किया जाएगा.

हस्ताक्षर:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

इससे यह तय होता है कि Firebase AppCheck लागू किया गया है या नहीं.

सही होने पर, अमान्य टोकन वाले अनुरोध 401 (बिना अनुमति) वाली गड़बड़ी के साथ अपने-आप रिस्पॉन्स देते हैं. गलत होने पर, अमान्य टोकन वाले अनुरोध कॉन्टेक्स्ट.app को तय न करने पर सेट करते हैं.

हस्ताक्षर:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

फ़ंक्शन की गड़बड़ी से जुड़ी नीति, जिसमें बूलियन true, खाली फिर से कोशिश करने वाले ऑब्जेक्ट देने के बराबर है.

हस्ताक्षर:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.inprogressSettings

इन्ग्रेस डेटा ट्रैफ़िक की सेटिंग. इनसे यह कंट्रोल किया जाता है कि इस फ़ंक्शन को कहां से कॉल किया जा सकता है.

हस्ताक्षर:

ingressSettings?: (typeof INGRESS_SETTINGS_OPTIONS)[number] | ResetValue;

RuntimeOptions.invoker

https फ़ंक्शन पर ऐक्सेस कंट्रोल सेट करने के लिए इन्वोकर.

हस्ताक्षर:

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

RuntimeOptions.labels

फ़ंक्शन पर सेट किए जाने वाले उपयोगकर्ता लेबल.

हस्ताक्षर:

labels?: Record<string, string>;

RuntimeOptions.maxInstances

साथ-साथ चलने के लिए बनाए गए असल इंस्टेंस की ज़्यादा से ज़्यादा संख्या.

हस्ताक्षर:

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

रनटाइम विकल्प.मेमोरी

फ़ंक्शन के लिए असाइन की जाने वाली मेमोरी.

हस्ताक्षर:

memory?: (typeof VALID_MEMORY_OPTIONS)[number] | Expression<number> | ResetValue;

RuntimeOptions.minInstances

किसी दिए गए समय पर चलने वाले असल इंस्टेंस की कम से कम संख्या.

इस्तेमाल न होने पर, इंस्टेंस के लिए मेमोरी असाइन करने और सीपीयू के 10% हिस्से का बिल भेजा जाएगा.

हस्ताक्षर:

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

RuntimeOptions.preserveExternalVariable

यह नीति कंट्रोल करती है कि फ़ंक्शन सोर्स के बाहर बदले गए फ़ंक्शन कॉन्फ़िगरेशन को सुरक्षित रखा जाए या नहीं. डिफ़ॉल्ट तौर पर, 'गलत' पर सेट होती है.

अगर मौजूदा प्लैटफ़ॉर्म में कोई ऐसा कॉन्फ़िगरेशन सेट अप करना है जो Firebase Functions SDK टूल में अभी उपलब्ध नहीं है, तो हमारा सुझाव है कि आप preserveExternalChanges को true पर सेट करें. ऐसा न करने पर, जब Firebase Functions SDK टूल का नया वर्शन रिलीज़ नहीं किया जाता है, तो हो सकता है कि आपके फ़ंक्शन की मैन्युअल रूप से कॉन्फ़िगर की गई सेटिंग अनजाने में मिट जाए.

हस्ताक्षर:

preserveExternalChanges?: boolean;

RuntimeOptions.secrets

हस्ताक्षर:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

फ़ंक्शन को चलाने के लिए, खास सेवा खाता.

हस्ताक्षर:

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

RuntimeOptions.timeoutseconds

फ़ंक्शन के लिए सेकंड में टाइम आउट हो गया, संभावित वैल्यू 0 से 540 हो सकती हैं.

हस्ताक्षर:

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

RuntimeOptions.vpcConnector

क्लाउड फ़ंक्शन को दिए गए VPC कनेक्टर से कनेक्ट करें.

हस्ताक्षर:

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

RuntimeOptions.vpcConnectorEग्रेससेटिंग

VPC कनेक्टर के लिए, इग्रेस डेटा ट्रैफ़िक की सेटिंग.

हस्ताक्षर:

vpcConnectorEgressSettings?: (typeof VPC_EGRESS_SETTINGS_OPTIONS)[number] | ResetValue;