REST Resource: organizations.settings

แหล่งข้อมูล: การตั้งค่า

สคีมาสําหรับการตั้งค่า ที่การตั้งค่าระบบคลาวด์ของทรัพยากรหนึ่งๆ การตั้งค่าหลักจะมีค่าได้ไม่เกิน 1 ค่า

การแสดง JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "readOnly": boolean,
  "dataType": enum (DataType),
  "defaultValue": {
    object (Value)
  }
}
ช่อง
name

string

ชื่อทรัพยากรของการตั้งค่า ต้องอยู่ในรูปแบบใดรูปแบบหนึ่งต่อไปนี้

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

ตัวอย่างเช่น "/projects/123/settings/gcp-enableMyFeature"
displayName

string

ชื่อที่มนุษย์อ่านได้สําหรับการตั้งค่านี้
description

string

คําอธิบายโดยละเอียดเกี่ยวกับการตั้งค่านี้
readOnly

boolean

แฟล็กที่บ่งชี้ว่าค่าของการตั้งค่านี้จะแก้ไขไม่ได้ (ดูเอกสารประกอบเกี่ยวกับการตั้งค่าและเหตุผลที่เฉพาะเจาะจง) แต่อาจมีการลบค่าโดยใช้ settings.deleteValue หาก DeleteSettingValueRequest.ignore_read_only ตั้งค่าเป็น "จริง" การใช้แฟล็กนี้ถือเป็นการรับทราบว่าจะไม่สามารถสร้างค่าการตั้งค่าใหม่ได้ ดูรายละเอียดเพิ่มเติมได้ที่ DeleteSettingValueRequest.ignore_read_only
dataType

enum (DataType)

ประเภทข้อมูลสําหรับการตั้งค่านี้
defaultValue

object (Value)

ค่าที่ settings.lookupEffectiveValue ได้รับหากไม่ได้ตั้งค่าไว้อย่างชัดเจน

หมายเหตุ: การตั้งค่าบางอย่างอาจไม่มีค่าเริ่มต้น

วิธีการ

deleteValue

 ลบค่าการตั้งค่า

getValue

 รับการตั้งค่า

list

 แสดงการตั้งค่าทั้งหมดที่มีในทรัพยากรระบบคลาวด์ parent

lookupEffectiveValue

 ประมวลผลค่าการตั้งค่าที่มีประสิทธิภาพของการตั้งค่าในทรัพยากรระบบคลาวด์ parent
ค้นหาค่าการตั้งค่าทั้งหมดที่มีอยู่ในทรัพยากร parent

updateValue

 อัปเดตค่าการตั้งค่า