params namespace

फ़ंक्शन

फ़ंक्शन	ब्यौरा
परिभाषितबूलियन(नाम, विकल्प)	बूलियन पैरामीटर का एलान करें.
FixInt(name, options)	पूर्णांक पैरामीटर बताएं.
परिभाषित सूची(नाम, विकल्प)	लिस्ट पैरामीटर का एलान करें.
FixSecret(name)	ऐसा सीक्रेट पैरामीटर तय करता है जिसमें वैल्यू सिर्फ़ Cloud Secret Manager में सेव रहेंगी. सीक्रेट, अंदरूनी तौर पर बाइटस्ट्रिंग के तौर पर सेव किए जाते हैं. पैरामीटर रिज़ॉल्यूशन के दौरान, संकेत देने के लिए ParamOptions.as का इस्तेमाल करें.
FixString(name, options)	स्ट्रिंग पैरामीटर का एलान करें.
एक से ज़्यादा विकल्प चुनें	वैल्यू की किसी सीरीज़ से, एक से ज़्यादा आइटम वाला इनपुट बनाएं.
एक से ज़्यादा विकल्प चुनें	लेबल के मैप से वैल्यू तक कई विकल्प वाला इनपुट बनाएं.
चुनें(विकल्प)	वैल्यू की सीरीज़ से कोई इनपुट चुनें.
चुनें(optionsWithLabels)	लेबल के मैप से मानों के लिए कोई इनपुट बनाएं.

क्लास

क्लास	ब्यौरा
अपने विचार

इंटरफ़ेस

इंटरफ़ेस	ब्यौरा
MultiSelectइनपुट	इससे यह तय होता है कि पैरामीटर की वैल्यू, उपयोगकर्ता को डिप्लॉय करते समय इंटरैक्टिव तरीके से पहले से तैयार किए गए विकल्पों की सूची में से किसी सबसेट को चुनने के बाद ही तय की जानी चाहिए. string[] के अलावा किसी दूसरे टाइप के पैरामीटर में इस्तेमाल करने पर गड़बड़ियां हो सकती हैं.
इनपुट चुनें	इस नीति से यह तय होता है कि पैरामीटर की वैल्यू, उपयोगकर्ता को डिप्लॉय करते समय इंटरैक्टिव तरीके से पहले से तैयार किए गए विकल्पों की सूची में से चुनने को ध्यान में रखकर तय की जानी चाहिए.
विकल्प चुनें	SelectInput को दिए गए विकल्पों में से एक, जिसमें वैल्यू के साथ-साथ ऐसा लेबल होता है जिसे लोग चुन सकते हैं. इसे चुने गए इंटरफ़ेस में दिखाया जा सकता है.
TextInput	इस नीति से यह तय होता है कि पैरामीटर की वैल्यू, डिप्लॉय करते समय उपयोगकर्ता को इंटरैक्टिव तरीके से टाइप करने के निर्देश देकर तय की जानी चाहिए. अगर कोई इनपुट दिया गया ConversionRegex मौजूद नहीं है, तो उसे फिर से सबमिट करने की कोशिश की जाएगी.

वैरिएबल

वैरिएबल	ब्यौरा
BUCKET_PICKER	किसी प्रोजेक्ट में बकेट की एक सूची अपने-आप जनरेट होने दें, जिसमें से कोई उपयोगकर्ता चुन सकता है.
databaseURL	पहले से मौजूद एक पैरामीटर, जो डिप्लॉयर को निर्देश दिए बिना, प्रोजेक्ट से जुड़े डिफ़ॉल्ट आरटीडीबी डेटाबेस यूआरएल के साथ काम करता है. कोई भी स्ट्रिंग मौजूद न होने पर खाली स्ट्रिंग.
डिक्लेयर किए गए पैरामीटर
gcloudProject	पहले से मौजूद एक पैरामीटर, जो डिप्लॉयर को निर्देश दिए बिना ही, Cloud प्रोजेक्ट आईडी के साथ काम करता है.
प्रोजेक्ट आईडी	पहले से मौजूद एक पैरामीटर, जो डिप्लॉयर को प्रॉम्प्ट किए बिना ही, प्रोजेक्ट से जुड़े Cloud प्रोजेक्ट आईडी के साथ काम करता है.
स्टोरेजबकेट	यह एक बिल्ट-इन पैरामीटर है, जो डिप्लॉयर को प्रॉम्प्ट किए बिना, फ़ंक्शन से जुड़े क्लाउड स्टोरेज बकेट तक ले जाता है. अगर तय नहीं किया गया है, तो स्ट्रिंग खाली है.

उपनामों का प्रकार

उपनाम टाइप करें	ब्यौरा
पैरामीटर के विकल्प	कॉन्फ़िगरेशन के विकल्प जिनका इस्तेमाल किसी पैरामीटर के प्रॉम्प्ट के व्यवहार को पसंद के मुताबिक बनाने के लिए किया जा सकता है.

params.enabledBoolean()

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

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
नाम	स्ट्रिंग	पैरामीटर को लोड करने के लिए, एनवायरमेंट वैरिएबल का नाम.
विकल्प	ParamOptions<बूलियन>	पैरामीटर के लिए कॉन्फ़िगरेशन विकल्प.

लौटाए जाने वाले प्रॉडक्ट:

बूलियनपैरम

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

params.enabledInt()

पूर्णांक पैरामीटर बताएं.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
नाम	स्ट्रिंग	पैरामीटर को लोड करने के लिए, एनवायरमेंट वैरिएबल का नाम.
विकल्प	ParamOptions<number>	पैरामीटर के लिए कॉन्फ़िगरेशन विकल्प.

लौटाए जाने वाले प्रॉडक्ट:

इंटपैरम

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

params.definedList()

लिस्ट पैरामीटर का एलान करें.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
नाम	स्ट्रिंग	पैरामीटर को लोड करने के लिए, एनवायरमेंट वैरिएबल का नाम.
विकल्प	ParamOptions<string[]>	पैरामीटर के लिए कॉन्फ़िगरेशन विकल्प.

लौटाए जाने वाले प्रॉडक्ट:

लिस्टपैरम

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

params.. हालांकिSecret()

ऐसा सीक्रेट पैरामीटर तय करता है जिसमें वैल्यू सिर्फ़ Cloud Secret Manager में सेव रहेंगी. सीक्रेट, अंदरूनी तौर पर बाइटस्ट्रिंग के तौर पर सेव किए जाते हैं. पैरामीटर रिज़ॉल्यूशन के दौरान, संकेत देने के लिए ParamOptions.as का इस्तेमाल करें.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
नाम	स्ट्रिंग	पैरामीटर को लोड करने के लिए, एनवायरमेंट वैरिएबल का नाम.

लौटाए जाने वाले प्रॉडक्ट:

सीक्रेटपैरम

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

params.detectString()

स्ट्रिंग पैरामीटर का एलान करें.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
नाम	स्ट्रिंग	पैरामीटर को लोड करने के लिए, एनवायरमेंट वैरिएबल का नाम.
विकल्प	ParamOptions<string>	पैरामीटर के लिए कॉन्फ़िगरेशन विकल्प.

लौटाए जाने वाले प्रॉडक्ट:

स्ट्रिंगपैम

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

params.multiSelect()

वैल्यू की किसी सीरीज़ से, एक से ज़्यादा आइटम वाला इनपुट बनाएं.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
विकल्प	स्ट्रिंग[]

लौटाए जाने वाले प्रॉडक्ट:

MultiSelectइनपुट

params.multiSelect()

लेबल के मैप से वैल्यू तक कई विकल्प वाला इनपुट बनाएं.

हस्ताक्षर:

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

पैरामीटर

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

लौटाए जाने वाले प्रॉडक्ट:

MultiSelectइनपुट

params.select()

वैल्यू की सीरीज़ से कोई इनपुट चुनें.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
विकल्प	टी[]

लौटाए जाने वाले प्रॉडक्ट:

Selectइनपुट<T>

params.select()

लेबल के मैप से मानों के लिए कोई इनपुट बनाएं.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर	टाइप	ब्यौरा
विकल्प के साथ लेबल के साथ	रिकॉर्ड<string, T>

लौटाए जाने वाले प्रॉडक्ट:

Selectइनपुट<T>

पैरामीटर.BUCKET_PICKER

किसी प्रोजेक्ट में बकेट की एक सूची अपने-आप जनरेट होने दें, जिसमें से कोई उपयोगकर्ता चुन सकता है.

हस्ताक्षर:

BUCKET_PICKER: ResourceInput

params.databaseURL

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

हस्ताक्षर:

databaseURL: Param<string>

params.deletedParams

हस्ताक्षर:

declaredParams: SecretOrExpr[]

params.gcloudProject

पहले से मौजूद एक पैरामीटर, जो डिप्लॉयर को निर्देश दिए बिना ही, Cloud प्रोजेक्ट आईडी के साथ काम करता है.

हस्ताक्षर:

gcloudProject: Param<string>

params.projectID

पहले से मौजूद एक पैरामीटर, जो डिप्लॉयर को प्रॉम्प्ट किए बिना ही, प्रोजेक्ट से जुड़े Cloud प्रोजेक्ट आईडी के साथ काम करता है.

हस्ताक्षर:

projectID: Param<string>

params.storageBucket

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

हस्ताक्षर:

storageBucket: Param<string>

params.ParamOptions

कॉन्फ़िगरेशन के विकल्प जिनका इस्तेमाल किसी पैरामीटर के प्रॉम्प्ट के व्यवहार को पसंद के मुताबिक बनाने के लिए किया जा सकता है.

हस्ताक्षर:

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