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

dataType

enum (DataType)

نوع البيانات لهذا الإعداد.

defaultValue

object (Value)

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

ملاحظة: ليست لكل الإعدادات قيمة تلقائية.

نوع البيانات

نوع البيانات لإعداد قيم هذا الإعداد. يمكنك الاطّلاع على Value لمزيد من التفاصيل عن أنواع البيانات المتاحة.

عمليات التعداد
DATA_TYPE_UNSPECIFIED نوع بيانات غير محدد.
BOOLEAN إعداد منطقي.
STRING إعداد سلسلة.
STRING_SET إعداد مجموعة سلاسل.

الطُرق

deleteValue

لحذف قيمة إعداد.

getValue

للحصول على قيمة إعداد.

list

يسرد جميع الإعدادات المتاحة على مورد Cloud parent.

lookupEffectiveValue

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

updateValue

يعدِّل قيمة إعداد