params namespace

פונקציות

פוּנקצִיָה תיאור
defineBoolean(שם, אפשרויות) הכריז על פרמטר בוליאני.
defineInt(שם, אפשרויות) הכריז על פרמטר של מספר שלם.
defineList(שם, אפשרויות) הכריז על פרמטר רשימה.
defineSecret(שם) מצהיר על פראם סודי, שימשיך ערכים רק ב-Cloud Secret Manager. סודות מאוחסנים באופן פנימי כ-bytestrings. השתמש ParamOptions.as כדי לספק רמז לסוג במהלך רזולוציית פרמטר.
defineString(שם, אפשרויות) הכריז על פרמטר מחרוזת.
multiSelect (אפשרויות) צור קלט מרובה בחירה מסדרה של ערכים.
multiSelect (אפשרויות) צור קלט רב בחירה ממפת תוויות לערכים.
בחר אופציות) צור קלט נבחר מתוך סדרה של ערכים.
select(optionsWithLabels) צור קלט נבחר ממפה של תוויות לערכים.

שיעורים

מעמד תיאור
ביטוי

ממשקים

מִמְשָׁק תיאור
MultiSelectInput מציין שיש לקבוע ערך של פרמטר על ידי כך שהמשתמש יבחר קבוצת משנה מתוך רשימה של אפשרויות מוכנות מראש באופן אינטראקטיבי בזמן הפריסה. יגרום לשגיאות אם נעשה שימוש בפרמטרים מסוג אחר מאשר string[] .
בחר קלט מציין שיש לקבוע ערך של פרמטר על ידי כך שהמשתמש יבחר מתוך רשימה של אפשרויות מוכנות מראש באופן אינטראקטיבי בזמן הפריסה.
בחר אופציות אחת האפשרויות הניתנות ל- SelectInput , המכילה ערך ובאופן אופציונלי תווית הניתנת לקריאה על ידי אדם להצגה בממשק הבחירה.
קלט טקסט מציין שיש לקבוע ערך של פרמטר על ידי הנחיה למשתמש להקליד אותו באופן אינטראקטיבי בזמן הפריסה. קלט שאינו תואם ל-validationRegex שסופק, אם קיים, ינסה שוב.

משתנים

מִשְׁתַנֶה תיאור
BUCKET_PICKER צור אוטומטית רשימה של דליים בפרויקט שמשתמש יכול לבחור מתוכם.
כתובת אתר של מסד נתונים פרמטר מובנה שפותר לכתובת ברירת המחדל של מסד הנתונים RTDB המשויכת לפרויקט, מבלי לבקש מהפריסה. מחרוזת ריקה אם לא קיימת.
הכריז על פארמס
gcloudProject פרמטר מובנה שפותר למזהה הפרויקט של הענן, מבלי לבקש מהפריס.
מזהה פרויקט פרמטר מובנה שפותר למזהה הפרויקט בענן המשויך לפרויקט, מבלי לבקש מהפרוס.
דלי אחסון פרמטר מובנה שפותר ל-Cloud Storage Bucket המשויך לפונקציה, מבלי לבקש מהפריס. מחרוזת ריקה אם לא מוגדרת.

הקלד כינויים

הקלד כינוי תיאור
ParamOptions אפשרויות תצורה שניתן להשתמש בהן כדי להתאים אישית את התנהגות הנחיה של פרמטר.

params.defineBoolean()

הכריז על פרמטר בוליאני.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שֵׁם חוּט שם משתנה הסביבה שישמש לטעינת הפרמטר.
אפשרויות ParamOptions <בוליאנית> אפשרויות תצורה של הפרמטר.

החזרות:

BooleanParam

פרמטר עם סוג החזרה boolean עבור .value .

params.defineInt()

הכריז על פרמטר של מספר שלם.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שֵׁם חוּט שם משתנה הסביבה שישמש לטעינת הפרמטר.
אפשרויות ParamOptions <מספר> אפשרויות תצורה של הפרמטר.

החזרות:

IntParam

פרמטר עם סוג החזרת number עבור .value .

params.defineList()

הכריז על פרמטר רשימה.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שֵׁם חוּט שם משתנה הסביבה שישמש לטעינת הפרמטר.
אפשרויות ParamOptions <string[]> אפשרויות תצורה של הפרמטר.

החזרות:

ListParam

פרמטר עם סוג החזרה מחרוזת string[] עבור .value .

params.defineSecret()

מצהיר על פראם סודי, שימשיך ערכים רק ב-Cloud Secret Manager. סודות מאוחסנים באופן פנימי כ-bytestrings. השתמש ParamOptions.as כדי לספק רמז לסוג במהלך רזולוציית פרמטר.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שֵׁם חוּט שם משתנה הסביבה שישמש לטעינת הפרמטר.

החזרות:

SecretParam

פרמטר עם סוג החזרת string עבור .value .

params.defineString()

הכריז על פרמטר מחרוזת.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
שֵׁם חוּט שם משתנה הסביבה שישמש לטעינת הפרמטר.
אפשרויות ParamOptions <string> אפשרויות תצורה של הפרמטר.

החזרות:

StringParam

פרמטר עם סוג החזרת string עבור .value .

params.multiSelect()

צור קלט מרובה בחירה מסדרה של ערכים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפשרויות חוּט[]

החזרות:

MultiSelectInput

params.multiSelect()

צור קלט רב בחירה ממפת תוויות לערכים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפשרויות הקלט<string, string>

החזרות:

MultiSelectInput

params.select()

צור קלט נבחר מתוך סדרה של ערכים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
אפשרויות T[]

החזרות:

בחר קלט <T>

params.select()

צור קלט נבחר ממפה של תוויות לערכים.

חֲתִימָה:

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

פרמטרים

פָּרָמֶטֶר סוּג תיאור
optionsWithLabels הקלט<string, T>

החזרות:

בחר קלט <T>

params.BUCKET_PICKER

צור אוטומטית רשימה של דליים בפרויקט שמשתמש יכול לבחור מתוכם.

חֲתִימָה:

BUCKET_PICKER: ResourceInput

params.databaseURL

פרמטר מובנה שפותר לכתובת ברירת המחדל של מסד הנתונים RTDB המשויכת לפרויקט, מבלי לבקש מהפריסה. מחרוזת ריקה אם לא קיימת.

חֲתִימָה:

databaseURL: Param<string>

params.declaredParams

חֲתִימָה:

declaredParams: SecretOrExpr[]

params.gcloudProject

פרמטר מובנה שפותר למזהה הפרויקט בענן, מבלי לבקש מהפריס.

חֲתִימָה:

gcloudProject: Param<string>

params.projectID

פרמטר מובנה שפותר למזהה הפרויקט בענן המשויך לפרויקט, מבלי להנחות את המפיץ.

חֲתִימָה:

projectID: Param<string>

params.storageBucket

פרמטר מובנה שפותר ל-Cloud Storage Bucket המשויך לפונקציה, מבלי לבקש מהפריס. מחרוזת ריקה אם לא מוגדרת.

חֲתִימָה:

storageBucket: Param<string>

params.ParamOptions

אפשרויות תצורה שניתן להשתמש בהן כדי להתאים אישית את התנהגות הנחיה של פרמטר.

חֲתִימָה:

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