REST Resource: organizations.settings

משאב: הגדרה

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

ייצוג 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 אם לא הוגדר ערך להגדרה באופן מפורש.

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

שיטות

deleteValue

 מתבצעת מחיקה של ערך הגדרה.

getValue

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

list

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

lookupEffectiveValue

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

updateValue

 הערך מתעדכן.