params namespace

कार्य

समारोह विवरण
डिफाइनबूलियन(नाम, विकल्प) एक बूलियन पैरामीटर घोषित करें.
परिभाषितInt (नाम, विकल्प) एक पूर्णांक पैरामीटर घोषित करें.
परिभाषित सूची (नाम, विकल्प) एक सूची पैरामीटर घोषित करें.
परिभाषित रहस्य(नाम) एक गुप्त पैरामीटर की घोषणा करता है, जो केवल क्लाउड सीक्रेट मैनेजर में मान बनाए रखेगा। रहस्य आंतरिक रूप से बायटेस्ट्रिंग्स के रूप में संग्रहीत होते हैं। पैरामीटर रिज़ॉल्यूशन के दौरान प्रकार संकेत प्रदान करने के लिए ParamOptions.as उपयोग करें।
परिभाषितस्ट्रिंग (नाम, विकल्प) एक स्ट्रिंग पैरामीटर घोषित करें.
बहुचयन(विकल्प) मानों की श्रृंखला से एक बहु-चयन इनपुट बनाएं।
बहुचयन(विकल्प) लेबल के मानचित्र से मानों तक एक बहु-चयन इनपुट बनाएं।
विकल्प चुनो) मानों की श्रृंखला से एक चयन इनपुट बनाएं।
चुनें(विकल्पविथलेबल) लेबल के मानचित्र से मानों तक एक चयन इनपुट बनाएं।

कक्षाओं

कक्षा विवरण
अभिव्यक्ति

इंटरफेस

इंटरफेस विवरण
मल्टीसेलेक्टइनपुट निर्दिष्ट करता है कि एक पैरामीटर का मान उपयोगकर्ता द्वारा तैनाती के समय इंटरैक्टिव रूप से पूर्व-डिब्बाबंद विकल्पों की सूची से एक सबसेट का चयन करके निर्धारित किया जाना चाहिए। यदि string[] के अलावा अन्य प्रकार के पैरामीटर पर उपयोग किया जाता है तो त्रुटियां होंगी।
इनपुट चुनें निर्दिष्ट करता है कि एक पैरामीटर का मान उपयोगकर्ता द्वारा तैनाती के समय इंटरैक्टिव रूप से पूर्व-डिब्बाबंद विकल्पों की सूची से चयन करके निर्धारित किया जाना चाहिए।
विकल्प चुनो SelectInput को प्रदान किए गए विकल्पों में से एक, जिसमें चयन इंटरफ़ेस में प्रदर्शित करने के लिए एक मान और वैकल्पिक रूप से एक मानव-पठनीय लेबल शामिल है।
पाठ इनपुट निर्दिष्ट करता है कि एक पैरामीटर का मान उपयोगकर्ता को तैनाती के समय इंटरैक्टिव रूप से टाइप करने के लिए प्रेरित करके निर्धारित किया जाना चाहिए। वह इनपुट जो दिए गए सत्यापनRegex से मेल नहीं खाता है, यदि मौजूद है, तो पुनः प्रयास किया जाएगा।

चर

चर विवरण
बाल्टी_पिकर किसी प्रोजेक्ट में बकेट की एक सूची स्वतः उत्पन्न करें जिसे उपयोगकर्ता चुन सकता है।
डेटाबेसURL एक अंतर्निर्मित पैरामीटर जो तैनातीकर्ता को संकेत दिए बिना, परियोजना से जुड़े डिफ़ॉल्ट आरटीडीबी डेटाबेस यूआरएल को हल करता है। यदि कोई मौजूद नहीं है तो खाली स्ट्रिंग।
घोषित पैरामीटर
gcloudप्रोजेक्ट एक अंतर्निहित पैरामीटर जो नियोक्ता को संकेत दिए बिना, क्लाउड प्रोजेक्ट आईडी का समाधान करता है।
प्रोजेक्टआईडी एक अंतर्निहित पैरामीटर जो तैनातीकर्ता को संकेत दिए बिना, परियोजना से जुड़े क्लाउड प्रोजेक्ट आईडी को हल करता है।
भंडारण बाल्टी एक अंतर्निहित पैरामीटर जो डिप्लॉयर को संकेत दिए बिना, फ़ंक्शन से जुड़े क्लाउड स्टोरेज बकेट को हल करता है। यदि परिभाषित नहीं है तो खाली स्ट्रिंग।

उपनाम टाइप करें

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

पैराम्स.डिफाइनबूलियन()

एक बूलियन पैरामीटर घोषित करें.

हस्ताक्षर:

export declare function defineBoolean(name: string, options?: ParamOptions<boolean>): BooleanParam;

पैरामीटर

पैरामीटर प्रकार विवरण
नाम डोरी पैरामीटर लोड करने के लिए उपयोग किए जाने वाले पर्यावरण चर का नाम.
विकल्प पैराऑप्शंस <बूलियन> पैरामीटर के लिए कॉन्फ़िगरेशन विकल्प.

रिटर्न:

बूलियनपरम

.value के लिए boolean रिटर्न प्रकार वाला एक पैरामीटर .

पैरामीटर्स.defineInt()

एक पूर्णांक पैरामीटर घोषित करें.

हस्ताक्षर:

export declare function defineInt(name: string, options?: ParamOptions<number>): IntParam;

पैरामीटर

पैरामीटर प्रकार विवरण
नाम डोरी पैरामीटर लोड करने के लिए उपयोग किए जाने वाले पर्यावरण चर का नाम।
विकल्प पैराऑप्शंस <संख्या> पैरामीटर के लिए कॉन्फ़िगरेशन विकल्प.

रिटर्न:

IntParam

.value के लिए number रिटर्न प्रकार वाला एक पैरामीटर .

पैरामीटर्स.defineList()

एक सूची पैरामीटर घोषित करें.

हस्ताक्षर:

export declare function defineList(name: string, options?: ParamOptions<string[]>): ListParam;

पैरामीटर

पैरामीटर प्रकार विवरण
नाम डोरी पैरामीटर लोड करने के लिए उपयोग किए जाने वाले पर्यावरण चर का नाम।
विकल्प पैराऑप्शंस <स्ट्रिंग[]> पैरामीटर के लिए कॉन्फ़िगरेशन विकल्प.

रिटर्न:

सूचीपरम

.value के लिए string[] रिटर्न प्रकार वाला एक पैरामीटर .

पैरामीटर्स.defineSecret()

एक गुप्त पैरामीटर की घोषणा करता है, जो केवल क्लाउड सीक्रेट मैनेजर में मान बनाए रखेगा। रहस्य आंतरिक रूप से बायटेस्ट्रिंग्स के रूप में संग्रहीत होते हैं। पैरामीटर रिज़ॉल्यूशन के दौरान प्रकार संकेत प्रदान करने के लिए ParamOptions.as उपयोग करें।

हस्ताक्षर:

export declare function defineSecret(name: string): SecretParam;

पैरामीटर

पैरामीटर प्रकार विवरण
नाम डोरी पैरामीटर लोड करने के लिए उपयोग किए जाने वाले पर्यावरण चर का नाम।

रिटर्न:

गुप्तपरम

.value के लिए string रिटर्न प्रकार वाला एक पैरामीटर .

पैरामीटर्स.defineString()

एक स्ट्रिंग पैरामीटर घोषित करें.

हस्ताक्षर:

export declare function defineString(name: string, options?: ParamOptions<string>): StringParam;

पैरामीटर

पैरामीटर प्रकार विवरण
नाम डोरी पैरामीटर लोड करने के लिए उपयोग किए जाने वाले पर्यावरण चर का नाम।
विकल्प पैराऑप्शंस <स्ट्रिंग> पैरामीटर के लिए कॉन्फ़िगरेशन विकल्प.

रिटर्न:

स्ट्रिंगपरम

.value के लिए string रिटर्न प्रकार वाला एक पैरामीटर .

पैराम्स.मल्टीसेलेक्ट()

मानों की श्रृंखला से एक बहु-चयन इनपुट बनाएं।

हस्ताक्षर:

export declare function multiSelect(options: string[]): MultiSelectInput;

पैरामीटर

पैरामीटर प्रकार विवरण
विकल्प डोरी[]

रिटर्न:

मल्टीसेलेक्टइनपुट

पैराम्स.मल्टीसेलेक्ट()

लेबल के मानचित्र से मानों तक एक बहु-चयन इनपुट बनाएं।

हस्ताक्षर:

export declare function multiSelect(options: Record<string, string>): MultiSelectInput;

पैरामीटर

पैरामीटर प्रकार विवरण
विकल्प रिकॉर्ड<स्ट्रिंग, स्ट्रिंग>

रिटर्न:

मल्टीसेलेक्टइनपुट

पैराम्स.चयन()

मानों की श्रृंखला से एक चयन इनपुट बनाएं।

हस्ताक्षर:

export declare function select<T>(options: T[]): SelectInput<T>;

पैरामीटर

पैरामीटर प्रकार विवरण
विकल्प टी[]

रिटर्न:

इनपुट चुनें <टी>

पैराम्स.चयन()

लेबल के मानचित्र से मानों तक एक चयन इनपुट बनाएं।

हस्ताक्षर:

export declare function select<T>(optionsWithLabels: Record<string, T>): SelectInput<T>;

पैरामीटर

पैरामीटर प्रकार विवरण
विकल्पविथलेबल्स रिकॉर्ड<स्ट्रिंग, टी>

रिटर्न:

इनपुट चुनें <टी>

पैरामीटर्स.BUCKET_PICKER

किसी प्रोजेक्ट में बकेट की एक सूची स्वतः उत्पन्न करें जिसे उपयोगकर्ता चुन सकता है।

हस्ताक्षर:

BUCKET_PICKER: ResourceInput

पैराम्स.डेटाबेसयूआरएल

एक अंतर्निर्मित पैरामीटर जो तैनातीकर्ता को संकेत दिए बिना, परियोजना से जुड़े डिफ़ॉल्ट आरटीडीबी डेटाबेस यूआरएल को हल करता है। यदि कोई मौजूद नहीं है तो खाली स्ट्रिंग।

हस्ताक्षर:

databaseURL: Param<string>

पैराम्स.घोषित पैराम्स

हस्ताक्षर:

declaredParams: SecretOrExpr[]

पैरामीटर्स.gcloudProject

एक अंतर्निहित पैरामीटर जो नियोक्ता को संकेत दिए बिना, क्लाउड प्रोजेक्ट आईडी का समाधान करता है।

हस्ताक्षर:

gcloudProject: Param<string>

पैरामीटर्स.प्रोजेक्टआईडी

एक अंतर्निहित पैरामीटर जो तैनातीकर्ता को संकेत दिए बिना, परियोजना से जुड़े क्लाउड प्रोजेक्ट आईडी को हल करता है।

हस्ताक्षर:

projectID: Param<string>

पैराम्स.स्टोरेजबकेट

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

हस्ताक्षर:

storageBucket: Param<string>

पैरामीटर्स.पैराऑप्शंस

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

हस्ताक्षर:

export type ParamOptions<T extends string | number | boolean | string[]> = Omit<ParamSpec<T>, "name" | "type">;