Package google.cloud.resourcesettings.v1alpha1

אינדקס

ResourceSettingsService

ממשק לאינטראקציה עם הגדרות משאבים וערכי הגדרות בכל היררכיית המשאבים.

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

לכל הבקשות, מחזירה google.rpc.Status עם google.rpc.Code.PERMISSION_DENIED אם בדיקת IAM נכשלת או אם משאב parent לא נמצא בארגון Cloud. לכל הבקשות, אם הבקשה היא בעלת מבנה פגום, הפונקציה מחזירה google.rpc.Status עם google.rpc.Code.INVALID_ARGUMENT.

הערה: לגבי כל ההגדרות בשלב אלפא, ההגדרה לא קיימת באף משאב בארגונים ב-Cloud שלא נמצאים בשלב אלפא.

CreateSettingValue

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

יוצרת ערך הגדרה.

הפונקציה מחזירה google.rpc.Status עם google.rpc.Code.NOT_FOUND אם ההגדרה לא קיימת. הפונקציה מחזירה google.rpc.Status עם google.rpc.Code.ALREADY_EXISTS אם ערך ההגדרה כבר קיים במשאב Cloud הנתון. מחזירה google.rpc.Status עם google.rpc.Code.FAILED_PRECONDITION אם ההגדרה מסומנת כקריאה בלבד.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין במאמר סקירה כללית על אימות.
DeleteSettingValue

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

מוחק ערך של הגדרה. אם ערך ההגדרה לא קיים, הפעולה לא מתבצעת.

הפונקציה מחזירה את הערך google.rpc.Status עם google.rpc.Code.NOT_FOUND אם ההגדרה או ערך ההגדרה לא קיימים. ערך ההגדרה לא יופיע אם קריאה קודמת ל-DeleteSetting עבור ערך ההגדרה כבר החזירה קוד הצלחה. מחזירה google.rpc.Status עם google.rpc.Code.FAILED_PRECONDITION אם ההגדרה מסומנת כקריאה בלבד.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין במאמר סקירה כללית על אימות.
GetSettingValue

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

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

הפונקציה מחזירה את הערך google.rpc.Status עם google.rpc.Code.NOT_FOUND אם ערך ההגדרה לא קיים.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין במאמר סקירה כללית על אימות.
ListSettings

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין במאמר סקירה כללית על אימות.
LookupEffectiveSettingValue

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

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

  1. ערך ההגדרה במשאב הנתון
  2. ערך ההגדרה במשאב הקרוב ביותר בהיררכיה של המשאב הנתון
  3. ערך ברירת המחדל של ההגדרה
  4. ערך הגדרה ריק, שמוגדר כ-SettingValue כשכל השדות לא מוגדרים

הפונקציה מחזירה google.rpc.Status עם google.rpc.Code.NOT_FOUND אם ההגדרה לא קיימת.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין במאמר סקירה כללית על אימות.
SearchSettingValues

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין במאמר סקירה כללית על אימות.
UpdateSettingValue

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

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

הפונקציה מחזירה את הערך google.rpc.Status עם google.rpc.Code.NOT_FOUND אם ההגדרה או ערך ההגדרה לא קיימים. מחזירה google.rpc.Status עם google.rpc.Code.FAILED_PRECONDITION אם ההגדרה מסומנת כקריאה בלבד. הפונקציה מחזירה את הערך google.rpc.Status עם google.rpc.Code.ABORTED אם ה-ETag שסופק בבקשה לא תואם ל-ETag שנשמר של ערך ההגדרה.

הערה: ערך ההגדרה שסופק יחליף את כל השדות.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

מידע נוסף זמין במאמר סקירה כללית על אימות.

CreateSettingValueRequest

הבקשה ל-CreateSettingValue.

שדות
setting_value

SettingValue

ערך ההגדרה שרוצים ליצור. SettingValueמידע על דרישות השדות

כדי להשתמש בהרשאה, צריך את הרשאת IAM הבאה במשאב שצוין settingValue:

  • resourcesettings.settingvalues.create

DeleteSettingValueRequest

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

שדות
name

string

השם של ערך ההגדרה שרוצים למחוק. SettingValue

כדי להשתמש בהרשאה, צריך את הרשאת IAM הבאה במשאב שצוין name:

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

דגל שמאפשר למחוק את הערך של הגדרה read_only. אזהרה: השימוש הוא באחריותך בלבד. מחיקת הערך של הגדרה לקריאה בלבד היא פעולה בלתי הפיכה (כלומר, אי אפשר ליצור אותה מחדש).

GetSettingValueRequest

הבקשה ל-GetSettingValue.

שדות
name

string

שם ערך ההגדרה שרוצים לקבל. SettingValue

כדי להשתמש בהרשאה, צריך את הרשאת IAM הבאה במשאב שצוין name:

  • resourcesettings.settingvalues.get

ListSettingsRequest

הבקשה ל-ListSettings.

שדות
parent

string

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

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

כדי להשתמש בהרשאה, צריך את הרשאת IAM הבאה במשאב שצוין parent:

  • resourcesettings.settings.list
page_size

int32

לא בשימוש. גודל הדף שיוחזר.
page_token

string

לא בשימוש. אסימון דף שמשמש לאחזור הדף הבא.

ListSettingsResponse

התשובה מ-ListSettings.

שדות
settings[]

Setting

רשימה של הגדרות שזמינות במשאב Cloud שצוין.
next_page_token

string

לא בשימוש. אסימון דף שמשמש לאחזור הדף הבא.

LookupEffectiveSettingValueRequest

הבקשה ל-LookupEffectiveSettingValue.

שדות
parent

string

ההגדרה שעבורה יחושב ערך בפועל. Setting

כדי להשתמש בהרשאה, צריך את הרשאת IAM הבאה במשאב שצוין parent:

  • resourcesettings.settingvalues.get

SearchSettingValuesRequest

הבקשה ל-SearchSettingValues.

שדות
parent

string

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

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

כדי להשתמש בהרשאה, צריך את הרשאת IAM הבאה במשאב שצוין parent:

  • resourcesettings.settingvalues.list
page_size

int32

לא בשימוש. גודל הדף שיוחזר.
page_token

string

לא בשימוש. אסימון דף שמשמש לאחזור הדף הבא.

SearchSettingValuesResponse

התשובה מ-SearchSettingValues.

שדות
setting_values[]

SettingValue

כל ערכי ההגדרות שקיימים במשאב Cloud שצוין.
next_page_token

string

לא בשימוש. אסימון דף שמשמש לאחזור הדף הבא.

הגדרה

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

שדות
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
display_name

string

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

string

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

bool

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

DataType

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

Value

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

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

DataType

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

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

SettingValue

המופע של הגדרה. כל ערך של הגדרה משויך להגדרה המתאימה.

שדות
name

string

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

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

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

Value

הערך של ההגדרה. סוג הנתונים של Value תמיד צריך להיות זהה לסוג הנתונים שמוגדר בהגדרת האב.
etag

string

טביעת אצבע שמשמשת לניהול מקבילי אופטימיסטי. פרטים נוספים מופיעים במאמר UpdateSettingValue.
read_only

bool

פלט בלבד. דגל שמציין שלא ניתן לשנות את ערך ההגדרה הזה. עם זאת, אפשר למחוק אותו באמצעות DeleteSettingValue אם DeleteSettingValueRequest.ignore_read_only מוגדר כ-true. השימוש בדגל הזה נחשב לאישור לכך שלא ניתן ליצור מחדש את ערך ההגדרה. הדגל הזה עובר בירושה מההגדרה ברמה העליונה, והוא נועד לנוחות. פרטים נוספים מופיעים במאמר Setting.read_only.
update_time

Timestamp

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

UpdateSettingValueRequest

הבקשה לעדכון הערך של ההגדרה.

שדות
setting_value

SettingValue

ערך ההגדרה לעדכון. SettingValueמידע על דרישות השדות

כדי להשתמש בהרשאה, צריך את הרשאת IAM הבאה במשאב שצוין settingValue:

  • resourcesettings.settingvalues.update

ערך

הנתונים בערך של הגדרה.

שדות
שדה איחוד value. בוחרים את סוג הנתונים ואת הערך המשויך. הערך value יכול להיות רק אחד מהבאים:
boolean_value

bool

הערך הזה מוגדר כערך בוליאני.
string_value

string

הערך הזה מוגדר כערך מחרוזת.
string_set_value

StringSet

הערך הזה מוגדר כ-StringSet.

StringSet

ערך של קבוצת מחרוזות שיכול להכיל קבוצה של מחרוזות. האורך המקסימלי של כל מחרוזת הוא 60 תווים, ויכולות להיות עד 50 מחרוזות במערך המחרוזות.

שדות
values[]

string

המחרוזות בקבוצה