REST Resource: folders.settings

משאב: הגדרה

הסכימה להגדרת ערכים. במשאב נתון בענן, הגדרה יכולה להיות הורה של ערך הגדרה אחד לכל היותר.

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "readOnly": boolean,
  "dataType": enum (DataType),
  "defaultValue": {
    object (Value)
  }
}
שדות
name

string

שם המשאב של ההגדרה. הערך חייב להיות באחד מהפורמטים הבאים:

  • projects/{project_number}/settings/{setting_name}
  • folders/{folder_id}/settings/{setting_name}
  • organizations/{organization_id}/settings/{setting_name}

לדוגמה, ‎/projects/123/settings/gcp-enableMyFeature
displayName

string

השם של ההגדרה הזו שקריא לבני אדם.
description

string

תיאור מפורט של הפעולה של ההגדרה הזו.
readOnly

boolean

דגל שמציין שלא ניתן לשנות את הערכים של ההגדרה הזו (מידע על עדכונים וסיבות מופיע במסמכי התיעוד של ההגדרה הספציפית). עם זאת, אפשר למחוק את ההגדרה באמצעות settings.deleteValue אם DeleteSettingValueRequest.ignore_read_only מוגדר כ-true. השימוש בדגל הזה נחשב לאישור לכך שלא ניתן ליצור מחדש את ערך ההגדרה. פרטים נוספים מופיעים במאמר DeleteSettingValueRequest.ignore_read_only.
dataType

enum (DataType)

סוג הנתונים של ההגדרה הזו.
defaultValue

object (Value)

הערך שמתקבל על ידי settings.lookupEffectiveValue אם לא מוגדר ערך להגדרה באופן מפורש.

הערה: לא לכל ההגדרות יש ערך ברירת מחדל.

DataType

סוג הנתונים להגדרת ערכים של ההגדרה הזו. לפרטים נוספים על סוגי הנתונים הזמינים, אפשר לעיין במאמר בנושא Value.

טיפוסים בני מנייה (enum)
DATA_TYPE_UNSPECIFIED סוג נתונים לא מוגדר.
BOOLEAN הגדרה בוליאנית.
STRING הגדרה של מחרוזת.
STRING_SET הגדרה של קבוצת מחרוזות.

Methods

deleteValue

 מוחק ערך של הגדרה.

getValue

 קבלת ערך של הגדרה.

list

 רשימה של כל ההגדרות שזמינות במשאב Cloud‏ parent.

lookupEffectiveValue

 מחשבת את ערך ההגדרה האפקטיבי של הגדרה במשאב Cloud‏ parent.
חיפוש של כל ערכי ההגדרה שקיימים במשאב parent.

updateValue

 מעדכנת את ערך ההגדרה.