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 เป็นเท็จ)

boolean

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

{
  "state": enum (State)
}

enum (State)

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