Package google.cloud.resourcesettings.v1alpha1

الفهرس

خدمة موارد الإعدادات

واجهة للتفاعل مع إعدادات الموارد وضبط القيم خلال التدرّج الهرمي للموارد

قد تعرض الخدمات عددًا من الإعدادات للمستخدمين للتحكم في سلوك مواردهم. يتم تقييم قيم الإعداد المطبَّقة على مورد Cloud معيّن بشكل هرمي وتوارثها جميع توابع هذا المورد.

بالنسبة إلى جميع الطلبات، يتم عرض google.rpc.Status مع google.rpc.Code.PERMISSION_DENIED إذا تعذّر التحقّق من "إدارة الهوية وإمكانية الوصول" أو إذا لم يكن مورد parent في مؤسسة على السحابة الإلكترونية. بالنسبة إلى جميع الطلبات، يتم عرض google.rpc.Status مع google.rpc.Code.INVALID_ARGUMENT إذا كان الطلب غير صحيح.

ملاحظة: بالنسبة إلى جميع إعدادات المرحلة الأولية، لا يوجد الإعداد ضمن أي موارد ليست في الإصدار الأولي للمؤسسات على السحابة الإلكترونية.

إنشاء قيمة الإعداد

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

لمزيد من المعلومات، اطلع على نظرة عامة على المصادقة.
حذف قيمة الإعداد

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

لمزيد من المعلومات، اطلع على نظرة عامة على المصادقة.
قيمة الإعداد

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

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

لعرض google.rpc.Status مع google.rpc.Code.NOT_FOUND إذا لم تكن قيمة الإعداد موجودة.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، اطلع على نظرة عامة على المصادقة.
إعدادات القائمة

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

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

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، اطلع على نظرة عامة على المصادقة.
البحث عن قيمة فعالة للإعداد

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

لحساب قيمة الإعداد الفعّالة لأحد الإعدادات في مورد السحابة الإلكترونية parent. قيمة الإعداد الفعّالة هي قيمة الإعداد المحسوبة على أحد موارد السحابة الإلكترونية، ويتم تقييمها باستخدام أحد الخيارات التالية بالترتيب المحدّد (يتم استخدام الخيار التالي في حال عدم وجود الخيار السابق):

  1. قيمة الإعداد على المورد المحدد
  2. قيمة الإعداد على أقرب سلف للمورد المحدد
  3. القيمة الافتراضية للإعداد
  4. قيمة إعداد فارغة، يتم تحديدها كـ SettingValue مع عدم ضبط جميع الحقول

لعرض google.rpc.Status مع google.rpc.Code.NOT_FOUND إذا لم يكن الإعداد موجودًا.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، اطلع على نظرة عامة على المصادقة.
قيم إعدادات البحث

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

للبحث عن جميع قيم الإعدادات المتاحة في المورد parent. لا تقتصر قيم الإعداد على قيم إعداد معين.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، اطلع على نظرة عامة على المصادقة.
قيمة إعداد التحديث

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

لمزيد من المعلومات، اطلع على نظرة عامة على المصادقة.

إنشاء إعدادValueValueRequest

طلب CreateSettingValue.

الحقول
setting_value

SettingValue

قيمة الإعداد المراد إنشاؤها. يُرجى الاطّلاع على SettingValue لمعرفة متطلبات الحقل.

يتطلب التفويض الحصول على إذن IAM التالي للمورد المحدَّد settingValue:

  • resourcesettings.settingvalues.create

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

طلب DeleteSettingValue.

الحقول
name

string

اسم قيمة الإعداد المطلوب حذفها. يمكنك الاطّلاع على SettingValue لمعرفة متطلبات التسمية.

يتطلب التفويض الحصول على إذن IAM التالي للمورد المحدَّد name:

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

علامة تسمح بحذف قيمة إعداد read_only. تحذير: استخدمه على مسؤوليتك الخاصة. يُعد حذف قيمة إعداد للقراءة فقط إجراءً لا يمكن التراجع عنه (أي لا يمكن إنشاؤه مرة أخرى).

GetSettingValueRequest

طلب GetSettingValue.

الحقول
name

string

اسم قيمة الإعداد المطلوب الحصول عليها. يمكنك الاطّلاع على SettingValue لمعرفة متطلبات التسمية.

يتطلب التفويض الحصول على إذن IAM التالي للمورد المحدَّد name:

  • resourcesettings.settingvalues.get

طلب قائمة الإعدادات

طلب "إعدادات القائمة".

الحقول
parent

string

مورد السحابة الإلكترونية الذي يضبط الإعداد الرئيسي. يجب أن يكون بأحد النماذج التالية:

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

يتطلب التفويض الحصول على إذن IAM التالي للمورد المحدَّد parent:

  • resourcesettings.settings.list
page_size

int32

غير مستخدم. حجم الصفحة المطلوب عرضها.
page_token

string

غير مستخدم. رمز صفحة مميز يُستخدم لاسترداد الصفحة التالية.

قائمة إعدادات الاستجابة

الاستجابة من ListSettings.

الحقول
settings[]

Setting

قائمة بالإعدادات المتوفرة في مورد السحابة الإلكترونية المحدَّد.
next_page_token

string

غير مستخدم. رمز صفحة مميز يُستخدم لاسترداد الصفحة التالية.

البحث عن قيمة فعالة للإعداد

طلب LookupeffectiveSettingValue.

الحقول
parent

string

الإعداد الذي سيتم تقييم قيمة فعّالة له. يمكنك الاطّلاع على Setting لمعرفة متطلبات التسمية.

يتطلب التفويض الحصول على إذن IAM التالي للمورد المحدَّد parent:

  • resourcesettings.settingvalues.get

طلب قيمة الإعدادات في شبكة البحث

طلب SearchSettingValues.

الحقول
parent

string

مورد السحابة الإلكترونية الذي يضبط الإعداد الرئيسي. يجب أن يكون بأحد النماذج التالية:

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

يتطلب التفويض الحصول على إذن IAM التالي للمورد المحدَّد parent:

  • resourcesettings.settingvalues.list
page_size

int32

غير مستخدم. حجم الصفحة المطلوب عرضها.
page_token

string

غير مستخدم. رمز صفحة مميز يُستخدم لاسترداد الصفحة التالية.

استجابةإعدادات البحث

الاستجابة من SearchSettingValues.

الحقول
setting_values[]

SettingValue

جميع قيم الإعدادات المتاحة في مورد Cloud المُحدّد.
next_page_token

string

غير مستخدم. رمز صفحة مميز يُستخدم لاسترداد الصفحة التالية.

الإعداد

مخطط تعيين القيم. عند استخدام مورد معيّن على Cloud، يمكن أن يكون للإعداد قيمة إعداد واحدة على الأكثر.

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

DataType

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

Value

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

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

نوع البيانات

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

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

قيمة الإعداد

مثيل الإعداد. وتتم إدارة كل قيمة إعداد من خلال الإعدادات الخاصة بها.

الحقول
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 على "صحيح". ويعتبر استخدام هذه العلامة إقرارًا بأنه لا يمكن إعادة إنشاء قيمة الإعداد. تم توارث هذه العلامة من إعداد المؤسسة الرئيسية لدواعي الملاءمة. لمزيد من التفاصيل، يُرجى الاطّلاع على Setting.read_only.
update_time

Timestamp

الإخراج فقط. الطابع الزمني الذي يشير إلى وقت آخر تعديل لقيمة الإعداد.

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

طلب UpdateSettingValue.

الحقول
setting_value

SettingValue

قيمة الإعداد المطلوب تحديثها. يُرجى الاطّلاع على SettingValue لمعرفة متطلبات الحقل.

يتطلب التفويض الحصول على إذن IAM التالي للمورد المحدَّد settingValue:

  • resourcesettings.settingvalues.update

القيمة

البيانات في قيمة الإعداد.

الحقول
حقل الاتحاد value. لاختيار نوع البيانات والقيمة المرتبطة بها. يمكن أن يكون value واحدًا مما يلي فقط:
boolean_value

bool

تعرّف هذه القيمة على أنها قيمة منطقية.
string_value

string

لتعريف هذه القيمة بوصفها قيمة سلسلة.
string_set_value

StringSet

لتعريف هذه القيمة كمجموعة StringSet.

مجموعة السلاسل

قيمة مجموعة سلاسل يمكنها الاحتفاظ بمجموعة من السلاسل. الحد الأقصى لطول كل سلسلة هو 60 حرفًا ويمكن أن يكون هناك 50 سلسلة كحد أقصى في مجموعة السلاسل.

الحقول
values[]

string

السلاسل في المجموعة