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 nilai setelan di seluruh hierarki resource.

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

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

Catatan: Untuk semua Setelan tahap alfa, Setelan tidak ada di resource mana pun di Cloud Organization yang tidak dalam tahap 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 yang diberikan. Menampilkan google.rpc.Status dengan google.rpc.Code.FAILED_PRECONDITION jika setelan ditandai sebagai hanya baca. Cakupan Otorisasi Memerlukan cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

DeleteSettingValue

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty) Menghapus nilai setelan. Jika nilai setelan tidak ada, operasi tidak akan dilakukan. 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 keberhasilan. Menampilkan google.rpc.Status dengan google.rpc.Code.FAILED_PRECONDITION jika setelan ditandai sebagai hanya baca. Cakupan Otorisasi Memerlukan cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, lihat 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: https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

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

LookupEffectiveSettingValue

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

SearchSettingValues
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: https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

UpdateSettingValue

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 melakukan penimpaan penuh pada semua kolom. Cakupan Otorisasi Memerlukan cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

CreateSettingValueRequest

Permintaan untuk CreateSettingValue.

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

DeleteSettingValueRequest

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 dengan menanggung sendiri risikonya. 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 menjadi induk setelan. Harus dalam salah satu bentuk 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.

LookupEffectiveSettingValueRequest

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 menjadi induk setelan. Harus dalam salah satu bentuk 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 menyetel nilai. Pada resource Cloud tertentu, setelan dapat memiliki paling banyak satu nilai setelan induk.

Kolom
name	string Nama resource setelan. Harus dalam salah satu bentuk 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 Flag yang menunjukkan bahwa nilai setelan ini tidak dapat diubah (lihat dokumentasi setelan tertentu untuk mengetahui update dan alasannya); namun, setelan ini dapat dihapus menggunakan DeleteSettingValue jika DeleteSettingValueRequest.ignore_read_only disetel ke benar (true). Penggunaan 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.

DataType

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

Enum
DATA_TYPE_UNSPECIFIED	Jenis data tidak ditentukan.
BOOLEAN	Setelan boolean.
STRING	Setelan string.
STRING_SET	Setelan set string.

SettingValue

Pembuatan instance setelan. Setiap nilai setelan dikaitkan dengan setelan yang sesuai.

Kolom
name	string Nama resource nilai setelan. Harus dalam salah satu bentuk 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 yang digunakan untuk konkurensi optimis. Lihat UpdateSettingValue untuk mengetahui detail selengkapnya.
read_only	bool Hanya output. Flag yang menunjukkan bahwa nilai setelan ini tidak dapat diubah; namun, nilai ini dapat dihapus menggunakan DeleteSettingValue jika DeleteSettingValueRequest.ignore_read_only disetel ke benar (true). Penggunaan tanda ini dianggap sebagai konfirmasi bahwa nilai setelan tidak dapat dibuat ulang. Flag ini diwarisi dari setelan induknya dan ditujukan 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 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 Mendefinisikan nilai ini sebagai nilai string.
string_set_value	StringSet Menentukan nilai ini sebagai StringSet.

StringSet

Nilai set string yang dapat menyimpan sekumpulan string. Panjang maksimum setiap string adalah 60 karakter dan maksimum ada 50 string dalam set string.

Kolom
values[]	string String dalam set