REST Resource: projects.databases.collectionGroups.fields

{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}

string

ต้องระบุ ชื่อช่องของแบบฟอร์ม projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

เส้นทางช่องอาจเป็นชื่อช่องที่เรียบง่าย เช่น address หรือเส้นทางไปยังช่องภายใน MAPValue เช่น address.city หรือเส้นทางช่องพิเศษ ช่องพิเศษที่ถูกต้องมีช่องเดียวคือ * ซึ่งจะแสดงแทนช่องใดก็ได้

เส้นทางช่องอาจระบุโดยใช้ (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]` และอักขระ ASCII ใดๆ ก็ตาม

ตัวอย่าง: (หมายเหตุ: ความคิดเห็นในที่นี้จะเขียนด้วยไวยากรณ์มาร์กดาวน์ จึงมีเครื่องหมายแบ็กทิกอีกชั้นเพื่อใช้แทนโค้ดบล็อก) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*` ไม่ใช่ช่องใดๆ

Field พิเศษมีการตั้งค่าการจัดทำดัชนีเริ่มต้นสำหรับทุกช่อง ชื่อทรัพยากรของช่องนี้คือ: ดัชนี projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* รายการที่กำหนดไว้ใน Field นี้จะมีผลกับทุกฟิลด์ที่ไม่มีการกำหนดค่าดัชนี Field ของตัวเอง

object (IndexConfig)

การกำหนดค่าดัชนีสำหรับช่องนี้ หากไม่ได้ตั้งค่า การจัดทำดัชนีช่องจะเปลี่ยนกลับไปเป็นการกำหนดค่าที่ ancestorField กำหนด หากต้องการนำดัชนีทั้งหมดสำหรับช่องนี้ออกอย่างชัดแจ้ง ให้ระบุการกำหนดค่าดัชนีที่มีรายการดัชนีที่ว่างเปล่า

object (TtlConfig)

การกำหนดค่า TTL สำหรับ Field นี้ การตั้งค่าหรือยกเลิกการตั้งค่านี้จะเป็นการเปิดหรือปิดใช้ TTL สำหรับเอกสารที่มี Field นี้

{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}

object (Index)

ดัชนีที่รองรับสำหรับช่องนี้

boolean

เอาต์พุตเท่านั้น เมื่อเป็นจริง ระบบจะตั้งค่าการกำหนดค่าดัชนีของ Field จากการกำหนดค่าที่ ancestorField ระบุ เมื่อเป็นเท็จ ระบบจะกำหนดค่าดัชนีของ Field อย่างชัดแจ้ง

string

เอาต์พุตเท่านั้น ระบุชื่อทรัพยากรของ Field ที่ใช้กำหนดค่าดัชนีของช่องนี้ (เมื่อ usesAncestorConfig เป็นจริง) หรือกำหนดจากที่จะตั้งค่าหากช่องนี้ไม่มีการกำหนดค่าดัชนี (เมื่อ usesAncestorConfig เป็น false)

boolean

แสดงผลเฉพาะเมื่อเป็น "จริง" การกำหนดค่าดัชนีของ Field กำลังอยู่ในระหว่างการเปลี่ยนกลับ เมื่อดำเนินการเสร็จแล้ว การกำหนดค่าดัชนีจะเปลี่ยนเป็นสถานะเดียวกับฟิลด์ที่ระบุโดย ancestorField ซึ่ง ณ จุดนี้ usesAncestorConfig จะเป็น true และ reverting จะเป็น false

{
  "state": enum (State)
}

enum (State)

เอาต์พุตเท่านั้น สถานะของการกำหนดค่า TTL