Package google.cloud.resourcesettings.v1alpha1

Dizin

KaynakAyarlar Hizmeti

Kaynak ayarları ile etkileşim kurmak ve kaynak hiyerarşisi boyunca değerleri ayarlamak için kullanılan bir arayüzdür.

Hizmetler, kullanıcıların kaynaklarının davranışlarını kontrol edebilmesi için çeşitli ayarlar gösterebilir. Belirli bir Cloud kaynağına uygulanan ayar değerleri hiyerarşik olarak değerlendirilir ve bu kaynağın tüm alt öğeleri tarafından devralınır.

Tüm istekler için IAM kontrolü başarısız olursa veya parent kaynağı bir Cloud kuruluşunda değilse google.rpc.Code.PERMISSION_DENIED ile bir google.rpc.Status döndürür. Tüm istekler için, isteğin bozuk olması durumunda google.rpc.Code.INVALID_ARGUMENT ile bir google.rpc.Status döndürür.

Not: Tüm alfa aşaması Ayarları için bu ayar, Cloud Kuruluşlarında alfa sürümünde olmayan hiçbir kaynak altında bulunmaz.

AyarAyar Değeri

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

Bir ayar değeri oluşturur.

Ayar mevcut değilse google.rpc.Code.NOT_FOUND ile bir google.rpc.Status döndürür. Ayar değeri belirli bir Cloud kaynağında zaten mevcutsa google.rpc.Code.ALREADY_EXISTS içeren bir google.rpc.Status döndürür. Ayar salt okunur olarak işaretlenmişse google.rpc.Code.FAILED_PRECONDITION ile bir google.rpc.Status döndürür.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleyi inceleyin.
Ayarın Değerini Sil

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

Bir ayar değerini siler. Ayar değeri mevcut değilse işlem bir işlem değildir.

Ayar veya ayar değeri yoksa google.rpc.Code.NOT_FOUND ile google.rpc.Status döndürür. Ayar değeri için daha önce DeleteSetting çağrısı yapıldığında başarı kodu döndürülmüşse ayar değeri mevcut olmaz. Ayar salt okunur olarak işaretlenmişse google.rpc.Code.FAILED_PRECONDITION ile bir google.rpc.Status döndürür.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleyi inceleyin.
Değer Ayarını Alma

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

Bir ayar değeri alır.

Ayar değeri yoksa google.rpc.Code.NOT_FOUND ile google.rpc.Status döndürür.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleyi inceleyin.
Liste Ayarları

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

parent adlı Cloud kaynağında bulunan tüm ayarları listeler.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleyi inceleyin.
AramaEtkiliAyarDeğeri

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

parent adlı Cloud kaynağındaki bir ayarın etkili ayar değerini hesaplar. Geçerli ayar değeri, bir Cloud kaynağında hesaplanan ayar değeridir ve belirtilen sırayla aşağıdaki seçeneklerden birini değerlendirir (bir önceki seçenek mevcut değilse sonraki seçenek kullanılır):

  1. değeri belirler
  2. Belirtilen kaynağın en yakın üst öğesindeki ayar değeri
  3. ayarın varsayılan değeri
  4. tüm alanlar ayarlanmadan SettingValue olarak tanımlanan boş bir ayar değeri

Ayar mevcut değilse google.rpc.Code.NOT_FOUND ile bir google.rpc.Status döndürür.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleyi inceleyin.
AramaAyarDeğerleri

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

parent kaynağında bulunan tüm ayar değerlerini arar. Ayar değerleri belirli bir ayarın değerleriyle sınırlı değildir.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleyi inceleyin.
Güncelleme Ayarı Değeri

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

Bir ayar değerini günceller.

Ayar veya ayar değeri yoksa google.rpc.Code.NOT_FOUND ile google.rpc.Status döndürür. Ayar salt okunur olarak işaretlenmişse google.rpc.Code.FAILED_PRECONDITION ile bir google.rpc.Status döndürür. İstekte sağlanan etag, ayar değerinin kalıcı etiketi ile eşleşmiyorsa google.rpc.Code.ABORTED ile google.rpc.Status döndürür.

Not: Sağlanan ayar değeri, tüm alanların üzerine yazılır.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış başlıklı makaleyi inceleyin.

Değer Ayarı Oluşturma İsteği

CreateSetValue isteği.

Alanlar
setting_value

SettingValue

Oluşturulacak ayar değeri. Alan gereksinimleri için SettingValue adresini ziyaret edin.

Yetkilendirme, belirtilen settingValue kaynağı için aşağıdaki IAM iznini gerektirir:

  • resourcesettings.settingvalues.create

AyarDeğeri İsteğini Sil

DeleteSettingsValue isteği.

Alanlar
name

string

Silinecek ayar değerinin adı. Adlandırma koşulları için SettingValueadresine bakın.

Yetkilendirme, belirtilen name kaynağı için aşağıdaki IAM iznini gerektirir:

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

Bir read_only ayarının değerinin silinmesine olanak tanıyan bir işaret. UYARI: Kullanım riski size aittir. Salt okunur ayarın değeri geri alınamaz (yani tekrar oluşturulamaz).

Ayar Ayarı Değer İsteği

GetSettingsValue isteği.

Alanlar
name

string

Alınacak ayar değerinin adı. Adlandırma koşulları için SettingValueadresine bakın.

Yetkilendirme, belirtilen name kaynağı için aşağıdaki IAM iznini gerektirir:

  • resourcesettings.settingvalues.get

Liste Ayarları İsteği

ListSettings isteği.

Alanlar
parent

string

Ayarı ebeveyn olarak ayarlayan Cloud kaynağı. Aşağıdaki biçimlerden birinde olmalıdır:

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

Yetkilendirme, belirtilen parent kaynağı için aşağıdaki IAM iznini gerektirir:

  • resourcesettings.settings.list
page_size

int32

Kullanılmayan. Döndürülecek sayfanın boyutu.
page_token

string

Kullanılmayan. Sonraki sayfayı almak için kullanılan sayfa jetonu.

Liste Ayarları yanıtı

ListSettings'den gelen yanıt.

Alanlar
settings[]

Setting

Belirtilen Cloud kaynağında bulunan ayarların listesi.
next_page_token

string

Kullanılmayan. Sonraki sayfayı almak için kullanılan sayfa jetonu.

AramaEtkiliAyarDeğerİsteği

LookupEffectiveSettingsValue isteği.

Alanlar
parent

string

Etkili bir değerin değerlendirileceği ayar. Adlandırma koşulları için Settingadresine bakın.

Yetkilendirme, belirtilen parent kaynağı için aşağıdaki IAM iznini gerektirir:

  • resourcesettings.settingvalues.get

Arama AyarıDeğerleriİstekleri

SearchSettingsValues isteği.

Alanlar
parent

string

Ayarı ebeveyn olarak ayarlayan Cloud kaynağı. Aşağıdaki biçimlerden birinde olmalıdır:

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

Yetkilendirme, belirtilen parent kaynağı için aşağıdaki IAM iznini gerektirir:

  • resourcesettings.settingvalues.list
page_size

int32

Kullanılmayan. Döndürülecek sayfanın boyutu.
page_token

string

Kullanılmayan. Sonraki sayfayı almak için kullanılan sayfa jetonu.

Arama AyarıDeğerleriYanıtı

SearchSETTINGValues yanıtı.

Alanlar
setting_values[]

SettingValue

Belirtilen Cloud kaynağında bulunan tüm ayar değerleri.
next_page_token

string

Kullanılmayan. Sonraki sayfayı almak için kullanılan sayfa jetonu.

Ayar

Değerleri ayarlama şeması. Belirli bir Cloud kaynağında, bir ayar en fazla bir ayar değerini değiştirebilir.

Alanlar
name

string

Ayarın kaynak adı. Aşağıdaki biçimlerden birinde olmalıdır:

  • projects/{project_number}/settings/{setting_name}
  • folders/{folder_id}/settings/{setting_name}
  • organizations/{organization_id}/settings/{setting_name}

Örneğin, "/projects/123/settings/gcp-enableMyFeature"
display_name

string

Bu ayar için okunabilir ad.
description

string

Bu ayarın işleviyle ilgili ayrıntılı açıklama.
read_only

bool

Bu ayarın değerlerinin değiştirilemediğini belirten bir işaret (güncellemeler ve nedenler için belirli bir ayarla ilgili belgelere bakın); ancak, DeleteSettingValueRequest.ignore_read_only doğru değerine ayarlanırsa DeleteSettingValue kullanılarak silinebilir. Bu işaretin kullanılması, ayar değerinin yeniden oluşturulamayacağına dair bir onay olarak kabul edilir. Ayrıntılı bilgi için DeleteSettingValueRequest.ignore_read_only göz atın.
data_type

DataType

Bu ayarın veri türü.
default_value

Value

Ayar değeri açıkça belirtilmemişse LookupEffectiveSettingValue tarafından alınan değer.

Not: Tüm ayarların varsayılan değeri yoktur.

DataType

Bu ayarın değerlerini belirlemek için kullanılan veri türü. Kullanılabilir veri türleri hakkında daha fazla bilgi için Value adresini ziyaret edin.

Sıralamalar
DATA_TYPE_UNSPECIFIED Belirtilmemiş veri türü.
BOOLEAN Boole ayarı.
STRING Bir dize ayarı.
STRING_SET Dize grubu ayarı.

AyarDeğeri

Bir ayarın örneği. Her ayar değeri, karşılık gelen ayara göre belirlenir.

Alanlar
name

string

Ayar değerinin kaynak adı. Aşağıdaki biçimlerden birinde olmalıdır:

  • projects/{project_number}/settings/{setting_name}/value
  • folders/{folder_id}/settings/{setting_name}/value
  • organizations/{organization_id}/settings/{setting_name}/value

Örneğin, "/projects/123/settings/gcp-enableMyFeature/value"
value

Value

Ayarın değeri. Value veri türü her zaman üst ayar tarafından tanımlanan veri türüyle tutarlı olmalıdır.
etag

string

İyimser eşzamanlılık için kullanılan bir parmak izi. Ayrıntılı bilgi için UpdateSettingValue göz atın.
read_only

bool

Yalnızca çıkış. Bu ayar değerinin değiştirilemeyeceğini gösteren bir işaret. Ancak DeleteSettingValueRequest.ignore_read_only doğru değerine ayarlanırsa DeleteSettingValue kullanılarak silinebilir. Bu işaretin kullanılması, ayar değerinin yeniden oluşturulamayacağına dair bir onay olarak kabul edilir. Bu işaret, üst ayarından devralınır ve kolaylık sağlamak amacıyla kullanılır. Ayrıntılı bilgi için Setting.read_only göz atın.
update_time

Timestamp

Yalnızca çıkış. Ayar değerinin en son ne zaman güncellendiğini gösteren zaman damgası.

AyarDeğeriİstekleri

UpdateSettingsValue isteği.

Alanlar
setting_value

SettingValue

Güncellenecek ayar değeri. Alan gereksinimleri için SettingValue adresini ziyaret edin.

Yetkilendirme, belirtilen settingValue kaynağı için aşağıdaki IAM iznini gerektirir:

  • resourcesettings.settingvalues.update

Değer

Bir ayar değerindeki veriler.

Alanlar
Birlik alanı value. Veri türünü ve ilişkili değeri seçer. value aşağıdakilerden yalnızca biri olabilir:
boolean_value

bool

Bu değeri boole değeri olarak tanımlar.
string_value

string

Bu değeri bir dize değeri olarak tanımlar.
string_set_value

StringSet

Bu değeri bir StringSet olarak tanımlar.

Dize Grubu

Bir dize grubunu barındırabilen bir dize grubu değeri. Her dizenin maksimum uzunluğu 60 karakterdir ve dize grubunda en fazla 50 dize olabilir.

Alanlar
values[]

string

Kümedeki dizeler