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

پرچمی که نشان می‌دهد مقادیر این تنظیم قابل تغییر نیستند (برای به‌روزرسانی‌ها و دلایل به مستندات تنظیمات خاص مراجعه کنید). با این حال، اگر DeleteSettingValueRequest.ignore_read_only روی true تنظیم شده باشد، ممکن است با استفاده از settings.deleteValue حذف شود. استفاده از این پرچم به منزله تصدیق این است که مقدار تنظیم را نمی توان دوباره ایجاد کرد. برای جزئیات بیشتر به DeleteSettingValueRequest.ignore_read_only مراجعه کنید.

dataType

enum ( DataType )

نوع داده برای این تنظیم.

defaultValue

object ( Value )

مقدار دریافت شده توسط settings.lookupEffectiveValue اگر مقدار تنظیمی به صراحت تنظیم نشده باشد.

توجه: همه تنظیمات دارای مقدار پیش فرض نیستند.

مواد و روش ها

deleteValue

 یک مقدار تنظیم را حذف می کند.

getValue

 یک مقدار تنظیم را دریافت می کند.

list

 تمام تنظیمات موجود در parent Cloud را فهرست می‌کند.

lookupEffectiveValue

 مقدار تنظیم مؤثر یک تنظیم را در منبع parent Cloud محاسبه می کند.
تمام مقادیر تنظیمات موجود در parent منبع را جستجو می کند.

updateValue

 یک مقدار تنظیم را به روز می کند.