REST Resource: projects.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

 แสดงการตั้งค่าทั้งหมดที่มีในทรัพยากร Cloud parent

lookupEffectiveValue

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

updateValue

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