Package google.cloud.resourcesettings.v1alpha1

Dizin

ResourceSettingsService

Kaynak hiyerarşisi genelinde kaynak ayarları ve ayar değerleriyle etkileşim kurmak için kullanılan bir arayüz.

Hizmetler, kullanıcıların kaynaklarının nasıl davranacağını kontrol etmesi için çeşitli ayarlar gösterebilir. Belirli bir Cloud kaynağında 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.Status ile google.rpc.Code.PERMISSION_DENIED değerini döndürür. Tüm istekler için, istek hatalıysa google.rpc.Status ile google.rpc.Code.INVALID_ARGUMENT döndürür.

Not: Tüm alfa aşaması ayarları için, alfa aşamasında olmayan Cloud kuruluşlarındaki kaynaklarda ayar bulunmaz.

CreateSettingValue

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

Ayar değeri oluşturur.

Ayar yoksa google.rpc.Status ile google.rpc.Code.NOT_FOUND değerini döndürür. Ayar değeri, belirtilen Cloud kaynağında zaten varsa google.rpc.Code.ALREADY_EXISTS ile google.rpc.Status değerini döndürür. Ayarlar salt okunur olarak işaretlenmişse google.rpc.Status ile google.rpc.Code.FAILED_PRECONDITION değerini 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.
DeleteSettingValue

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

Bir ayar değerini siler. Ayar değeri yoksa işlem yapılmaz.

Ayar veya ayar değeri yoksa google.rpc.Code.NOT_FOUND ile google.rpc.Status değerini döndürür. Ayar değeri için DeleteSetting'ya yapılan önceki bir çağrı zaten bir başarı kodu döndürdüyse ayar değeri mevcut olmaz. Ayarlar salt okunur olarak işaretlenmişse google.rpc.Status ile google.rpc.Code.FAILED_PRECONDITION değerini 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.
GetSettingValue

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

Bir ayar değerini alır.

Ayar değeri yoksa google.rpc.Status ile google.rpc.Code.NOT_FOUND değerini 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.
ListSettings

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

Cloud kaynağında parent 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.
LookupEffectiveSettingValue

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

Bulut kaynağındaki bir ayarın etkin ayar değerini hesaplar parent. Etkili ayar değeri, bir Cloud kaynağında hesaplanan ayar değeridir ve verilen sırayla aşağıdaki seçeneklerden birini değerlendirir (önceki seçenek yoksa sonraki seçenek kullanılır):

  1. belirli bir kaynaktaki ayar değeri
  2. Belirli bir kaynağın en yakın üst öğesindeki ayar değeri
  3. ayarın varsayılan değeri
  4. Tüm alanları ayarlanmamış bir SettingValue olarak tanımlanan boş ayar değeri

Ayar yoksa google.rpc.Status ile google.rpc.Code.NOT_FOUND değerini 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.
SearchSettingValues

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

Kaynakta parent bulunan tüm ayar değerlerini arar. Ayarların 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.
UpdateSettingValue

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 değerini döndürür. Ayarlar salt okunur olarak işaretlenmişse google.rpc.Status ile google.rpc.Code.FAILED_PRECONDITION değerini döndürür. İstekle sağlanan etag, ayar değerinin kalıcı etag'iyle 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 tamamen üzerine yazılmasını sağlar.

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.

CreateSettingValueRequest

CreateSettingValue isteği.

Alanlar
setting_value

SettingValue

Oluşturulacak ayar değeri. Alan koşulları için SettingValue bölümüne bakın.

Yetkilendirme için belirtilen kaynakta settingValue aşağıdaki IAM izni gerekir:

  • resourcesettings.settingvalues.create

DeleteSettingValueRequest

DeleteSettingValue isteği.

Alanlar
name

string

Silinecek ayar değerinin adı. Adlandırma koşulları için SettingValue bölümüne bakın.

Yetkilendirme için belirtilen kaynakta name aşağıdaki IAM izni gerekir:

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

Bir read_only ayarının değerinin silinmesine izin veren işaret. UYARI: Kullanım riski size aittir. Salt okunur bir ayarın değerini silme işlemi geri alınamaz (yani tekrar oluşturulamaz).

GetSettingValueRequest

GetSettingValue isteği.

Alanlar
name

string

Alınacak ayar değerinin adı. Adlandırma koşulları için SettingValue bölümüne bakın.

Yetkilendirme için belirtilen kaynakta name aşağıdaki IAM izni gerekir:

  • resourcesettings.settingvalues.get

ListSettingsRequest

ListSettings isteği.

Alanlar
parent

string

Ayarın üst öğesi olan Cloud kaynağı. Aşağıdaki biçimlerden birinde olmalıdır:

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

Yetkilendirme için belirtilen kaynakta parent aşağıdaki IAM izni gerekir:

  • resourcesettings.settings.list
page_size

int32

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

string

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

ListSettingsResponse

ListSettings'ten gelen yanıt.

Alanlar
settings[]

Setting

Belirtilen Cloud kaynağında kullanılabilen ayarların listesi.
next_page_token

string

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

LookupEffectiveSettingValueRequest

LookupEffectiveSettingValue isteği.

Alanlar
parent

string

Etkili değerin değerlendirileceği ayar. Adlandırma koşulları için Setting bölümüne bakın.

Yetkilendirme için belirtilen kaynakta parent aşağıdaki IAM izni gerekir:

  • resourcesettings.settingvalues.get

SearchSettingValuesRequest

SearchSettingValues isteği.

Alanlar
parent

string

Ayarın üst öğesi olan Cloud kaynağı. Aşağıdaki biçimlerden birinde olmalıdır:

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

Yetkilendirme için belirtilen kaynakta parent aşağıdaki IAM izni gerekir:

  • resourcesettings.settingvalues.list
page_size

int32

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

string

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

SearchSettingValuesResponse

SearchSettingValues'dan gelen yanıt.

Alanlar
setting_values[]

SettingValue

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

string

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

Yer

Değerleri ayarlama şeması. Belirli bir bulut kaynağında, bir ayar en fazla bir ayar değerine üst öğe olabilir.

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ın kullanıcılar tarafından okunabilecek adı.
description

string

Bu ayarın ne yaptığına dair 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 ayarın belgelerine bakın); ancak DeleteSettingValueRequest.ignore_read_only doğru olarak ayarlanırsa DeleteSettingValue kullanılarak silinebilir. Bu işaretin kullanılması, ayar değerinin yeniden oluşturulamayacağının kabul edildiği anlamına gelir. Daha fazla ayrıntı için DeleteSettingValueRequest.ignore_read_only sayfasına bakın.
data_type

DataType

Bu ayarın veri türü.
default_value

Value

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

Not: Bazı ayarların varsayılan değeri yoktur.

DataType

Bu ayarın değerlerini ayarlamak için kullanılan veri türü. Kullanılabilir veri türleri hakkında daha fazla bilgi için Value başlıklı makaleyi inceleyin.

Sıralamalar
DATA_TYPE_UNSPECIFIED Belirtilmemiş veri türü.
BOOLEAN Boole ayarı.
STRING Dize ayarı.
STRING_SET Dize kümesi ayarı.

SettingValue

Bir ayarın örneği. Her ayar değeri, ilgili ayarın üst öğesidir.

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 öğesinin 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 parmak izi. Daha fazla ayrıntı için UpdateSettingValue sayfasına bakın.
read_only

bool

Yalnızca çıkış. Bu ayar değerinin değiştirilemeyeceğini belirten bir işaret. Ancak DeleteSettingValue kullanılarak silinebilir. Bunun için DeleteSettingValueRequest.ignore_read_only değerinin doğru (true) olarak ayarlanması gerekir. Bu işaretin kullanılması, ayar değerinin yeniden oluşturulamayacağının kabul edildiği anlamına gelir. Bu işaret, üst ayarından devralınır ve kolaylık sağlamak amacıyla kullanılır. Daha fazla ayrıntı için Setting.read_only sayfasına bakın.
update_time

Timestamp

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

UpdateSettingValueRequest

UpdateSettingValue isteği.

Alanlar
setting_value

SettingValue

Güncellenecek ayar değeri. Alan koşulları için SettingValue bölümüne bakın.

Yetkilendirme için belirtilen kaynakta settingValue aşağıdaki IAM izni gerekir:

  • resourcesettings.settingvalues.update

Değer

Bir ayar değerindeki veriler.

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

bool

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

string

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

StringSet

Bu değeri StringSet olarak tanımlar.

StringSet

Bir dize kümesi değeridir ve dize kümesi içerebilir. Her dizenin maksimum uzunluğu 60 karakterdir ve dize kümesinde en fazla 50 dize olabilir.

Alanlar
values[]

string

Kümedeki dizeler