RuntimeOptions interface

किसी फ़ंक्शन के लिए कॉन्फ़िगरेशन विकल्प जो रनटाइम पर लागू होते हैं।

हस्ताक्षर:

export interface RuntimeOptions 

गुण

संपत्ति प्रकार विवरण
उपभोगऐपचेकटोकन बूलियन निर्धारित करता है कि अनुरोध पर फायरबेस ऐप चेक टोकन का उपभोग किया जाता है या नहीं। डिफ़ॉल्ट से असत्य.
EnforceAppCheck बूलियन निर्धारित करता है कि फायरबेस ऐपचेक लागू किया गया है या नहीं।
असफलता नीति असफलता नीति | बूलियन फ़ंक्शन की विफलता नीति, बूलियन true के साथ एक खाली पुनः प्रयास ऑब्जेक्ट प्रदान करने के बराबर है।
प्रवेश सेटिंग्स ( INGRESS_SETTINGS_OPTIONS का प्रकार )[संख्या] | रीसेट वैल्यू प्रवेश सेटिंग्स जो नियंत्रित करती हैं कि इस फ़ंक्शन को कहां से कॉल किया जा सकता है।
आह्वानकर्ता "सार्वजनिक" | "निजी" | स्ट्रिंग | डोरी[] https फ़ंक्शंस पर एक्सेस कंट्रोल सेट करने के लिए इनवॉकर।
लेबल रिकॉर्ड<स्ट्रिंग, स्ट्रिंग> फ़ंक्शन पर सेट करने के लिए उपयोगकर्ता लेबल।
maxInstances संख्या | अभिव्यक्ति <संख्या> | रीसेट वैल्यू वास्तविक उदाहरणों की अधिकतम संख्या को समानांतर में चलने की अनुमति है।
याद ( VALID_MEMORY_OPTIONS का प्रकार )[संख्या] | अभिव्यक्ति <संख्या> | रीसेट वैल्यू फ़ंक्शन को आवंटित की जाने वाली मेमोरी की मात्रा.
minInstances संख्या | अभिव्यक्ति <संख्या> | रीसेट वैल्यू किसी निश्चित समय पर चलने वाले वास्तविक उदाहरणों की न्यूनतम संख्या।
बाह्यपरिवर्तन संरक्षित करें बूलियन नियंत्रित करता है कि फ़ंक्शन स्रोत के बाहर संशोधित फ़ंक्शन कॉन्फ़िगरेशन संरक्षित है या नहीं। डिफ़ॉल्ट से असत्य.
रहस्य (स्ट्रिंग | सीक्रेटपरम)[]
सेवा खाता "डिफ़ॉल्ट" | स्ट्रिंग | अभिव्यक्ति <स्ट्रिंग> | रीसेट वैल्यू फ़ंक्शन को चलाने के लिए विशिष्ट सेवा खाता।
समयबाह्यसेकंड संख्या | अभिव्यक्ति <संख्या> | रीसेट वैल्यू फ़ंक्शन के लिए सेकंड में टाइमआउट, संभावित मान 0 से 540 हैं।
vpcकनेक्टर स्ट्रिंग | अभिव्यक्ति <स्ट्रिंग> | रीसेट वैल्यू क्लाउड फ़ंक्शन को निर्दिष्ट वीपीसी कनेक्टर से कनेक्ट करें।
vpcConnectorEgressSettings ( VPC_EGRESS_SETTINGS_OPTIONS का प्रकार )[संख्या] | रीसेट वैल्यू वीपीसी कनेक्टर के लिए निकास सेटिंग्स।

RuntimeOptions.consumeAppCheckToken

निर्धारित करता है कि अनुरोध पर फायरबेस ऐप चेक टोकन का उपभोग किया जाता है या नहीं। डिफ़ॉल्ट से असत्य.

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

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

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

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

हस्ताक्षर:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

निर्धारित करता है कि फायरबेस ऐपचेक लागू किया गया है या नहीं।

सही होने पर, अमान्य टोकन वाले अनुरोध 401 (अनधिकृत) त्रुटि के साथ स्वत: प्रतिक्रिया देते हैं। गलत होने पर, अमान्य टोकन वाले अनुरोध context.app को अपरिभाषित पर सेट करते हैं।

हस्ताक्षर:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

फ़ंक्शन की विफलता नीति, बूलियन true के साथ एक खाली पुनः प्रयास ऑब्जेक्ट प्रदान करने के बराबर है।

हस्ताक्षर:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

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

हस्ताक्षर:

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

RuntimeOptions.invoker

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

हस्ताक्षर:

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

रनटाइमऑप्शंस.लेबल

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

हस्ताक्षर:

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.preserveExternalChanges

नियंत्रित करता है कि फ़ंक्शन स्रोत के बाहर संशोधित फ़ंक्शन कॉन्फ़िगरेशन संरक्षित है या नहीं। डिफ़ॉल्ट से असत्य.

अंतर्निहित प्लेटफ़ॉर्म में उपलब्ध कॉन्फ़िगरेशन सेट करते समय जो अभी तक फ़ायरबेस फ़ंक्शंस एसडीके में उपलब्ध नहीं है, हम अत्यधिक preserveExternalChanges को true पर सेट करने की सलाह देते हैं . अन्यथा, जब फायरबेस फ़ंक्शंस एसडीके लापता कॉन्फ़िगरेशन के समर्थन के साथ एसडीके का एक नया संस्करण जारी करता है, तो आपके फ़ंक्शन की मैन्युअल रूप से कॉन्फ़िगर की गई सेटिंग अनजाने में मिटा दी जा सकती है।

हस्ताक्षर:

preserveExternalChanges?: boolean;

रनटाइमऑप्शंस.रहस्य

हस्ताक्षर:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

फ़ंक्शन को चलाने के लिए विशिष्ट सेवा खाता।

हस्ताक्षर:

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

RuntimeOptions.timeoutSeconds

फ़ंक्शन के लिए सेकंड में टाइमआउट, संभावित मान 0 से 540 हैं।

हस्ताक्षर:

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

RuntimeOptions.vpcConnector

क्लाउड फ़ंक्शन को निर्दिष्ट वीपीसी कनेक्टर से कनेक्ट करें।

हस्ताक्षर:

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

RuntimeOptions.vpcConnectorEgressSettings

वीपीसी कनेक्टर के लिए निकास सेटिंग्स।

हस्ताक्षर:

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

किसी फ़ंक्शन के लिए कॉन्फ़िगरेशन विकल्प जो रनटाइम पर लागू होते हैं।

हस्ताक्षर:

export interface RuntimeOptions 

गुण

संपत्ति प्रकार विवरण
उपभोगऐपचेकटोकन बूलियन निर्धारित करता है कि अनुरोध पर फायरबेस ऐप चेक टोकन का उपभोग किया जाता है या नहीं। डिफ़ॉल्ट से असत्य.
EnforceAppCheck बूलियन निर्धारित करता है कि फायरबेस ऐपचेक लागू किया गया है या नहीं।
असफलता नीति असफलता नीति | बूलियन फ़ंक्शन की विफलता नीति, बूलियन true के साथ एक खाली पुनः प्रयास ऑब्जेक्ट प्रदान करने के बराबर है।
प्रवेश सेटिंग्स ( INGRESS_SETTINGS_OPTIONS का प्रकार )[संख्या] | रीसेट वैल्यू प्रवेश सेटिंग्स जो नियंत्रित करती हैं कि इस फ़ंक्शन को कहां से कॉल किया जा सकता है।
आह्वानकर्ता "सार्वजनिक" | "निजी" | स्ट्रिंग | डोरी[] https फ़ंक्शंस पर एक्सेस कंट्रोल सेट करने के लिए इनवॉकर।
लेबल रिकॉर्ड<स्ट्रिंग, स्ट्रिंग> फ़ंक्शन पर सेट करने के लिए उपयोगकर्ता लेबल।
maxInstances संख्या | अभिव्यक्ति <संख्या> | रीसेट वैल्यू वास्तविक उदाहरणों की अधिकतम संख्या को समानांतर में चलने की अनुमति है।
याद ( VALID_MEMORY_OPTIONS का प्रकार )[संख्या] | अभिव्यक्ति <संख्या> | रीसेट वैल्यू फ़ंक्शन को आवंटित की जाने वाली मेमोरी की मात्रा.
minInstances संख्या | अभिव्यक्ति <संख्या> | रीसेट वैल्यू किसी निश्चित समय पर चलने वाले वास्तविक उदाहरणों की न्यूनतम संख्या।
बाह्यपरिवर्तन संरक्षित करें बूलियन नियंत्रित करता है कि फ़ंक्शन स्रोत के बाहर संशोधित फ़ंक्शन कॉन्फ़िगरेशन संरक्षित है या नहीं। डिफ़ॉल्ट से असत्य.
रहस्य (स्ट्रिंग | सीक्रेटपरम)[]
सेवा खाता "डिफ़ॉल्ट" | स्ट्रिंग | अभिव्यक्ति <स्ट्रिंग> | रीसेट वैल्यू फ़ंक्शन को चलाने के लिए विशिष्ट सेवा खाता।
समयबाह्यसेकंड संख्या | अभिव्यक्ति <संख्या> | रीसेट वैल्यू फ़ंक्शन के लिए सेकंड में टाइमआउट, संभावित मान 0 से 540 हैं।
vpcकनेक्टर स्ट्रिंग | अभिव्यक्ति <स्ट्रिंग> | रीसेट वैल्यू क्लाउड फ़ंक्शन को निर्दिष्ट वीपीसी कनेक्टर से कनेक्ट करें।
vpcConnectorEgressSettings ( VPC_EGRESS_SETTINGS_OPTIONS का प्रकार )[संख्या] | रीसेट वैल्यू वीपीसी कनेक्टर के लिए निकास सेटिंग्स।

RuntimeOptions.consumeAppCheckToken

निर्धारित करता है कि अनुरोध पर फायरबेस ऐप चेक टोकन का उपभोग किया जाता है या नहीं। डिफ़ॉल्ट से असत्य.

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

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

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

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

हस्ताक्षर:

consumeAppCheckToken?: boolean;

RuntimeOptions.enforceAppCheck

निर्धारित करता है कि फायरबेस ऐपचेक लागू किया गया है या नहीं।

सही होने पर, अमान्य टोकन वाले अनुरोध 401 (अनधिकृत) त्रुटि के साथ स्वत: प्रतिक्रिया देते हैं। गलत होने पर, अमान्य टोकन वाले अनुरोध context.app को अपरिभाषित पर सेट करते हैं।

हस्ताक्षर:

enforceAppCheck?: boolean;

RuntimeOptions.failurePolicy

फ़ंक्शन की विफलता नीति, बूलियन true के साथ एक खाली पुनः प्रयास ऑब्जेक्ट प्रदान करने के बराबर है।

हस्ताक्षर:

failurePolicy?: FailurePolicy | boolean;

RuntimeOptions.ingressSettings

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

हस्ताक्षर:

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

RuntimeOptions.invoker

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

हस्ताक्षर:

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

रनटाइमऑप्शंस.लेबल

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

हस्ताक्षर:

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.preserveExternalChanges

नियंत्रित करता है कि फ़ंक्शन स्रोत के बाहर संशोधित फ़ंक्शन कॉन्फ़िगरेशन संरक्षित है या नहीं। डिफ़ॉल्ट से असत्य.

अंतर्निहित प्लेटफ़ॉर्म में उपलब्ध कॉन्फ़िगरेशन सेट करते समय जो अभी तक फ़ायरबेस फ़ंक्शंस एसडीके में उपलब्ध नहीं है, हम अत्यधिक preserveExternalChanges को true पर सेट करने की सलाह देते हैं . अन्यथा, जब फायरबेस फ़ंक्शंस एसडीके लापता कॉन्फ़िगरेशन के समर्थन के साथ एसडीके का एक नया संस्करण जारी करता है, तो आपके फ़ंक्शन की मैन्युअल रूप से कॉन्फ़िगर की गई सेटिंग अनजाने में मिटा दी जा सकती है।

हस्ताक्षर:

preserveExternalChanges?: boolean;

रनटाइमऑप्शंस.रहस्य

हस्ताक्षर:

secrets?: (string | SecretParam)[];

RuntimeOptions.serviceAccount

फ़ंक्शन को चलाने के लिए विशिष्ट सेवा खाता।

हस्ताक्षर:

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

RuntimeOptions.timeoutSeconds

फ़ंक्शन के लिए सेकंड में टाइमआउट, संभावित मान 0 से 540 हैं।

हस्ताक्षर:

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

RuntimeOptions.vpcConnector

क्लाउड फ़ंक्शन को निर्दिष्ट वीपीसी कनेक्टर से कनेक्ट करें।

हस्ताक्षर:

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

RuntimeOptions.vpcConnectorEgressSettings

वीपीसी कनेक्टर के लिए निकास सेटिंग्स।

हस्ताक्षर:

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