REST Resource: organizations.settings

Resource: Setting

Skema untuk menyetel nilai. Pada resource Cloud tertentu, setelan dapat memiliki paling banyak satu nilai setelan induk.

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "readOnly": boolean,
  "dataType": enum (DataType),
  "defaultValue": {
    object (Value)
  }
}
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"
displayName

string

Nama yang dapat dibaca manusia untuk setelan ini.
description

string

Deskripsi mendetail tentang fungsi setelan ini.
readOnly

boolean

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 settings.deleteValue 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.
dataType

enum (DataType)

Jenis data untuk setelan ini.
defaultValue

object (Value)

Nilai yang diterima oleh settings.lookupEffectiveValue jika tidak ada nilai setelan yang ditetapkan secara eksplisit.

Catatan: tidak semua setelan memiliki nilai default.

Metode

deleteValue

 Menghapus nilai setelan.

getValue

 Mendapatkan nilai setelan.

list

 Mencantumkan semua setelan yang tersedia di resource Cloud parent.

lookupEffectiveValue

 Menghitung nilai setelan efektif dari setelan di resource Cloud parent.
Menelusuri semua nilai setelan yang ada di resource parent.

updateValue

 Memperbarui nilai setelan.