Package google.cloud.resourcesettings.v1alpha1

Indeks

• ResourceSettingsService (antarmuka)
• CreateSettingValueRequest (pesan)
• DeleteSettingValueRequest (pesan)
• GetSettingValueRequest (pesan)
• ListSettingsRequest (pesan)
• ListSettingsResponse (pesan)
• LookupEffectiveSettingValueRequest (pesan)
• SearchSettingValuesRequest (pesan)
• SearchSettingValuesResponse (pesan)
• Setting (pesan)
• Setting.DataType (enum)
• SettingValue (pesan)
• UpdateSettingValueRequest (pesan)
• Value (pesan)
• Value.StringSet (pesan)

ResourceSettingsService

Antarmuka untuk berinteraksi dengan setelan resource dan menetapkan nilai di seluruh hierarki resource.

Layanan dapat menampilkan sejumlah setelan bagi pengguna untuk mengontrol perilaku resource-nya. Nilai setelan yang diterapkan pada resource Cloud tertentu akan dievaluasi secara hierarkis dan diwarisi oleh semua turunan resource tersebut.

Untuk semua permintaan, tampilkan google.rpc.Status dengan google.rpc.Code.PERMISSION_DENIED jika pemeriksaan IAM gagal atau resource parent tidak berada dalam Organisasi Cloud. Untuk semua permintaan, tampilkan google.rpc.Status dengan google.rpc.Code.INVALID_ARGUMENT jika format permintaan salah.

Catatan: Untuk semua Setelan tahap alfa, Setelan tidak ada dalam resource apa pun di Organisasi Cloud yang tidak ada di alfa.

CreateSettingValue

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue) Membuat nilai setelan. Menampilkan google.rpc.Status dengan google.rpc.Code.NOT_FOUND jika setelan tidak ada. Menampilkan google.rpc.Status dengan google.rpc.Code.ALREADY_EXISTS jika nilai setelan sudah ada di resource Cloud tertentu. Menampilkan google.rpc.Status dengan google.rpc.Code.FAILED_PRECONDITION jika setelan ditandai sebagai hanya baca. Cakupan Otorisasi Memerlukan cakupan OAuth berikut ini: https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, baca Ringkasan Autentikasi.

MenghapusSettingValue

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty) Menghapus nilai setelan. Jika nilai setelan tidak ada, operasi tidak dioperasikan. Menampilkan google.rpc.Status dengan google.rpc.Code.NOT_FOUND jika setelan atau nilai setelan tidak ada. Nilai setelan tidak akan ada jika panggilan sebelumnya ke DeleteSetting untuk nilai setelan sudah menampilkan kode sukses. Menampilkan google.rpc.Status dengan google.rpc.Code.FAILED_PRECONDITION jika setelan ditandai sebagai hanya baca. Cakupan Otorisasi Memerlukan cakupan OAuth berikut ini: https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, baca Ringkasan Autentikasi.

GetSettingValue
rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue) Mendapatkan nilai setelan. Menampilkan google.rpc.Status dengan google.rpc.Code.NOT_FOUND jika nilai setelan tidak ada. Cakupan Otorisasi Memerlukan cakupan OAuth berikut ini: https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, baca Ringkasan Autentikasi.

SetelanDaftar
rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse) Mencantumkan semua setelan yang tersedia di resource Cloud parent. Cakupan Otorisasi Memerlukan cakupan OAuth berikut ini: https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, baca Ringkasan Autentikasi.

LookupEffectiveSettingValue

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue) Menghitung nilai setelan efektif dari setelan di resource Cloud parent. Nilai setelan yang efektif adalah nilai setelan yang dihitung di resource Cloud dan dievaluasi ke salah satu opsi berikut di urutan yang diberikan (opsi berikutnya digunakan jika yang sebelumnya tidak ada): nilai setelan pada resource yang diberikan nilai setelan pada ancestor terdekat dari resource yang diberikan nilai default setelan nilai setelan kosong, didefinisikan sebagai SettingValue dengan semua kolom tidak ditetapkan Menampilkan google.rpc.Status dengan google.rpc.Code.NOT_FOUND jika setelan tidak ada. Cakupan Otorisasi Memerlukan cakupan OAuth berikut ini: https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, baca Ringkasan Autentikasi.

NilaiSetelan Penelusuran
rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse) Menelusuri semua nilai setelan yang ada di resource parent. Nilai setelan tidak terbatas pada nilai setelan tertentu. Cakupan Otorisasi Memerlukan cakupan OAuth berikut ini: https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, baca Ringkasan Autentikasi.

MengupdateSetelanNilai

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue) Memperbarui nilai setelan. Menampilkan google.rpc.Status dengan google.rpc.Code.NOT_FOUND jika setelan atau nilai setelan tidak ada. Menampilkan google.rpc.Status dengan google.rpc.Code.FAILED_PRECONDITION jika setelan ditandai sebagai hanya baca. Menampilkan google.rpc.Status dengan google.rpc.Code.ABORTED jika etag yang diberikan dalam permintaan tidak cocok dengan etag nilai setelan yang dipertahankan. Catatan: nilai setelan yang diberikan akan menimpa seluruh kolom. Cakupan Otorisasi Memerlukan cakupan OAuth berikut ini: https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, baca Ringkasan Autentikasi.

CreateSettingValueRequest

Permintaan untuk CreateSettingValue.

Kolom
setting_value	SettingValue Nilai setelan yang akan dibuat. Lihat SettingValue untuk mengetahui persyaratan kolom. Otorisasi memerlukan izin IAM berikut pada resource yang ditentukan settingValue: resourcesettings.settingvalues.create

MenghapusSettingValueRequest

Permintaan untuk DeleteSettingValue.

Kolom
name	string Nama nilai setelan yang akan dihapus. Lihat SettingValue untuk mengetahui persyaratan penamaan. Otorisasi memerlukan izin IAM berikut pada resource yang ditentukan name: resourcesettings.settingvalues.delete
ignore_read_only	bool Flag yang memungkinkan penghapusan nilai setelan read_only. PERINGATAN: gunakan risiko Anda sendiri. Menghapus nilai setelan hanya baca adalah tindakan yang tidak dapat diurungkan (yaitu, tidak dapat dibuat lagi).

GetSettingValueRequest

Permintaan untuk GetSettingValue.

Kolom
name	string Nama nilai setelan yang akan didapatkan. Lihat SettingValue untuk mengetahui persyaratan penamaan. Otorisasi memerlukan izin IAM berikut pada resource yang ditentukan name: resourcesettings.settingvalues.get

ListSettingsRequest

Permintaan untuk ListSettings.

Kolom
parent	string Resource Cloud yang digunakan orang tua untuk menetapkan setelan. Harus dalam salah satu format berikut: projects/{project_number} projects/{project_id} folders/{folder_id} organizations/{organization_id} Otorisasi memerlukan izin IAM berikut pada resource yang ditentukan parent: resourcesettings.settings.list
page_size	int32 Tidak digunakan. Ukuran halaman yang akan ditampilkan.
page_token	string Tidak digunakan. Token halaman yang digunakan untuk mengambil halaman berikutnya.

ListSettingsResponse

Respons dari ListSettings.

Kolom
settings[]	Setting Daftar setelan yang tersedia di resource Cloud yang ditentukan.
next_page_token	string Tidak digunakan. Token halaman yang digunakan untuk mengambil halaman berikutnya.

LookupEffectiveValueValueRequest

Permintaan untuk LookupEffectiveSettingValue.

Kolom
parent	string Setelan yang nilai efektifnya akan dievaluasi. Lihat Setting untuk mengetahui persyaratan penamaan. Otorisasi memerlukan izin IAM berikut pada resource yang ditentukan parent: resourcesettings.settingvalues.get

SearchSettingValuesRequest

Permintaan untuk SearchSettingValues.

Kolom
parent	string Resource Cloud yang digunakan orang tua untuk menetapkan setelan. Harus dalam salah satu format berikut: projects/{project_number} projects/{project_id} folders/{folder_id} organizations/{organization_id} Otorisasi memerlukan izin IAM berikut pada resource yang ditentukan parent: resourcesettings.settingvalues.list
page_size	int32 Tidak digunakan. Ukuran halaman yang akan ditampilkan.
page_token	string Tidak digunakan. Token halaman yang digunakan untuk mengambil halaman berikutnya.

SearchSettingValuesResponse

Respons dari SearchSettingValues.

Kolom
setting_values[]	SettingValue Semua nilai setelan yang ada di resource Cloud yang ditentukan.
next_page_token	string Tidak digunakan. Token halaman yang digunakan untuk mengambil halaman berikutnya.

Setelan

Skema untuk menetapkan nilai. Pada resource Cloud tertentu, setelan dapat menambah maksimal satu nilai setelan.

Kolom
name	string Nama resource setelan. Harus dalam salah satu format berikut: projects/{project_number}/settings/{setting_name} folders/{folder_id}/settings/{setting_name} organizations/{organization_id}/settings/{setting_name} Misalnya, "/projects/123/settings/gcp-enableMyFeature"
display_name	string Nama yang dapat dibaca manusia untuk setelan ini.
description	string Deskripsi mendetail tentang fungsi setelan ini.
read_only	bool Tanda yang menunjukkan bahwa nilai setelan ini tidak dapat diubah (lihat dokumentasi setelan tertentu untuk mengetahui pembaruan dan alasan); namun, nilai dapat dihapus menggunakan DeleteSettingValue jika DeleteSettingValueRequest.ignore_read_only disetel ke benar (true). Menggunakan tanda ini dianggap sebagai konfirmasi bahwa nilai setelan tidak dapat dibuat ulang. Lihat DeleteSettingValueRequest.ignore_read_only untuk mengetahui detail selengkapnya.
data_type	DataType Jenis data untuk setelan ini.
default_value	Value Nilai yang diterima oleh LookupEffectiveSettingValue jika tidak ada nilai setelan yang ditetapkan secara eksplisit. Catatan: tidak semua setelan memiliki nilai default.

JenisData

Jenis data untuk menetapkan nilai setelan ini. Lihat Value untuk detail selengkapnya tentang jenis data yang tersedia.

Enumerasi
DATA_TYPE_UNSPECIFIED	Jenis data belum ditentukan.
BOOLEAN	Setelan boolean.
STRING	Setelan string.
STRING_SET	Setelan kumpulan string.

NilaiSetelan

Pembuatan instance setelan. Setiap nilai setelan diinduki oleh setelan yang sesuai.

Kolom
name	string Nama resource nilai setelan. Harus dalam salah satu format berikut: projects/{project_number}/settings/{setting_name}/value folders/{folder_id}/settings/{setting_name}/value organizations/{organization_id}/settings/{setting_name}/value Misalnya, "/projects/123/settings/gcp-enableMyFeature/value"
value	Value Nilai setelan. Jenis data Value harus selalu konsisten dengan jenis data yang ditentukan oleh setelan induk.
etag	string Sidik jari digunakan untuk konkurensi optimistis. Lihat UpdateSettingValue untuk mengetahui detail selengkapnya.
read_only	bool Hanya output. Flag yang menunjukkan bahwa nilai setelan ini tidak dapat diubah; namun, nilai tersebut dapat dihapus menggunakan DeleteSettingValue jika DeleteSettingValueRequest.ignore_read_only ditetapkan ke true. Menggunakan tanda ini dianggap sebagai konfirmasi bahwa nilai setelan tidak dapat dibuat ulang. Tanda ini diwarisi dari setelan induknya dan untuk tujuan kenyamanan. Lihat Setting.read_only untuk mengetahui detail selengkapnya.
update_time	Timestamp Hanya output. Stempel waktu yang menunjukkan kapan nilai setelan terakhir diperbarui.

UpdateSettingValueRequest

Permintaan untuk UpdateSettingValue.

Kolom
setting_value	SettingValue Nilai setelan yang akan diperbarui. Lihat SettingValue untuk mengetahui persyaratan kolom. Otorisasi memerlukan izin IAM berikut pada resource yang ditentukan settingValue: resourcesettings.settingvalues.update

Nilai

Data dalam nilai setelan.

Kolom
Kolom union value. Memilih jenis data dan nilai terkait. value hanya dapat berupa salah satu dari berikut:
boolean_value	bool Menentukan nilai ini sebagai nilai boolean.
string_value	string Menentukan nilai ini sebagai nilai string.
string_set_value	StringSet Menentukan nilai ini sebagai StringSet.

Set String

Nilai kumpulan string yang dapat menyimpan serangkaian string. Panjang maksimum setiap string adalah 60 karakter dan maksimum 50 string dalam kumpulan string.

Kolom
values[]	string String dalam kumpulan