Package google.cloud.resourcesettings.v1alpha1

الفهرس

ResourceSettingsService

واجهة للتفاعل مع إعدادات الموارد وقيم الإعدادات في جميع أنحاء التسلسل الهرمي للموارد

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

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

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

CreateSettingValue

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

تنشئ هذه السمة قيمة إعداد.

تعرِض google.rpc.Status مع google.rpc.Code.NOT_FOUND إذا لم يكن الإعداد متوفّرًا. تعرض هذه الطريقة google.rpc.Status مع google.rpc.Code.ALREADY_EXISTS إذا كانت قيمة الإعداد متوفّرة من قبل على مورد السحابة الإلكترونية المحدّد. تعرِض هذه السمة 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)

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

نطاقات التفويض

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

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

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
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

طلب 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

ListSettingsRequest

طلب ListSettings

الحقول
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

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

ListSettingsResponse

الردّ من ListSettings

الحقول
settings[]

Setting

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

string

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

LookupEffectiveSettingValueRequest

طلب LookupEffectiveSettingValue

الحقول
parent

string

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

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

  • resourcesettings.settingvalues.get

SearchSettingValuesRequest

طلب 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

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

SearchSettingValuesResponse

الردّ من SearchSettingValues

الحقول
setting_values[]

SettingValue

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

DataType

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

Value

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

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

DataType

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

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

Timestamp

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

UpdateSettingValueRequest

تمثّل هذه السمة طلب UpdateSettingValue.

الحقول
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

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