REST Resource: projects.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 على "صحيح". يُعدّ استخدام هذه العلامة إقرارًا بأنّه لا يمكن إعادة إنشاء قيمة الإعداد. يمكنك الاطّلاع على DeleteSettingValueRequest.ignore_read_only لمزيد من التفاصيل.

dataType

enum (DataType)

تمثّل هذه السمة نوع البيانات لهذا الإعداد.

defaultValue

object (Value)

القيمة التي يتلقّاها settings.lookupEffectiveValue إذا لم يتم ضبط قيمة الإعداد بشكلٍ صريح.

ملاحظة: لا تتضمّن بعض الإعدادات قيمة تلقائية.

الطُرق

deleteValue

تحذف هذه الطريقة قيمة أحد الإعدادات.

getValue

تعرض هذه الدالة قيمة أحد الإعدادات.

list

تعرِض هذه الصفحة جميع الإعدادات المتوفّرة في مورد السحابة الإلكترونية parent.

lookupEffectiveValue

تحسب هذه السمة قيمة الإعداد الفعّالة لإعداد معيّن في مورد السحابة الإلكترونية parent.
يبحث عن جميع قيم الإعدادات المتوفّرة في المرجع parent.

updateValue

تعديل قيمة أحد الإعدادات