Package google.cloud.resourcesettings.v1alpha1

شاخص

ResourceSettingsService

رابطی برای تعامل با تنظیمات منابع و تعیین مقادیر در سرتاسر سلسله مراتب منابع.

سرویس ها ممکن است تعدادی تنظیمات را برای کاربران به نمایش بگذارند تا نحوه رفتار منابع خود را کنترل کنند. مقادیر تنظیمی اعمال شده بر روی یک منبع Cloud معین به صورت سلسله مراتبی ارزیابی شده و توسط همه فرزندان آن منبع به ارث می رسد.

برای همه درخواست‌ها، اگر بررسی IAM ناموفق باشد یا منبع parent در یک سازمان Cloud نباشد، یک google.rpc.Status با google.rpc.Code.PERMISSION_DENIED برمی‌گرداند. برای همه درخواست‌ها، اگر درخواست نادرست باشد، یک google.rpc.Status با google.rpc.Code.INVALID_ARGUMENT برمی‌گرداند.

توجه: برای همه تنظیمات مرحله آلفا، تنظیمات تحت هیچ منبعی در سازمان‌های ابری که در آلفا نیستند وجود ندارد.

CreateSettingValue

rpc CreateSettingValue( CreateSettingValueRequest ) returns ( SettingValue )

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

اگر تنظیم وجود نداشته باشد، یک google.rpc.Status با google.rpc.Code.NOT_FOUND برمی‌گرداند. اگر مقدار تنظیم از قبل در منبع داده شده Cloud وجود داشته باشد، یک 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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

تنظیمات لیست

rpc ListSettings( ListSettingsRequest ) returns ( ListSettingsResponse )

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

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

LookupEffectiveSettingValue

rpc LookupEffectiveSettingValue( LookupEffectiveSettingValueRequest ) returns ( SettingValue )

مقدار تنظیم مؤثر یک تنظیم را در منبع parent Cloud محاسبه می کند. مقدار تنظیم موثر، مقدار تنظیم محاسبه شده در یک منبع Cloud است و به یکی از گزینه های زیر به ترتیب داده شده ارزیابی می شود (گزینه بعدی در صورت عدم وجود گزینه قبلی استفاده می شود):

  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 برمی‌گرداند.

توجه: مقدار تنظیم ارائه شده بازنویسی کامل تمام فیلدها را انجام می دهد.

محدوده مجوز

به محدوده 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

منبع Cloud که والدین آن تنظیمات هستند. باید به یکی از اشکال زیر باشد:

  • 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

منبع Cloud که والدین آن تنظیمات هستند. باید به یکی از اشکال زیر باشد:

  • 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

تمام مقادیر تنظیمی که در منبع 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

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

data_type

DataType

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

default_value

Value

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

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

نوع داده

نوع داده برای تنظیم مقادیر این تنظیم. برای جزئیات بیشتر در مورد انواع داده های موجود، Value ببینید.

Enums
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

فقط خروجی پرچمی که نشان می دهد این مقدار تنظیم قابل تغییر نیست. با این حال، اگر DeleteSettingValueRequest.ignore_read_only روی true تنظیم شده باشد، ممکن است با استفاده از DeleteSettingValue حذف شود. استفاده از این پرچم به منزله تصدیق این است که مقدار تنظیم را نمی توان دوباره ایجاد کرد. این پرچم از تنظیمات والدین خود به ارث رسیده است و برای اهداف راحتی است. برای جزئیات بیشتر به 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

رشته های موجود در مجموعه