FieldOperationMetadata

ข้อมูลเมตาสำหรับผลลัพธ์ google.longrunning.Operation รายการจาก FirestoreAdmin.UpdateField

การแสดง JSON 
{
  "startTime": string,
  "endTime": string,
  "field": string,
  "indexConfigDeltas": [
    {
      object (IndexConfigDelta)
    }
  ],
  "state": enum (OperationState),
  "progressDocuments": {
    object (Progress)
  },
  "progressBytes": {
    object (Progress)
  },
  "ttlConfigDelta": {
    object (TtlConfigDelta)
  }
}
ช่อง
startTime

string (Timestamp format)

เวลาที่การดำเนินการนี้เริ่มต้น

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขที่เป็นเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
endTime

string (Timestamp format)

เวลาที่การดำเนินการนี้เสร็จสมบูรณ์ ระบบจะยกเลิกการตั้งค่าหากยังดำเนินการอยู่

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขที่เป็นเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
field

string

ทรัพยากรฟิลด์ที่การดำเนินการนี้ดำเนินการ เช่น projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}
indexConfigDeltas[]

object (IndexConfigDelta)

รายการของ IndexConfigDelta ซึ่งอธิบายเจตนาของการดำเนินการนี้
state

enum (OperationState)

สถานะของการดำเนินการ
progressDocuments

object (Progress)

ความคืบหน้าในเอกสารของการดำเนินการนี้
progressBytes

object (Progress)

ความคืบหน้าในหน่วยไบต์ของการดำเนินการนี้
ttlConfigDelta

object (TtlConfigDelta)

อธิบายเดลต้าของการกำหนดค่า TTL

IndexConfigDelta

ข้อมูลเกี่ยวกับการเปลี่ยนแปลงการกำหนดค่าดัชนี

การแสดง JSON 
{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}
ช่อง
changeType

enum (ChangeType)

ระบุการเปลี่ยนแปลงของดัชนี
index

object (Index)

ดัชนีที่เปลี่ยนแปลง

ดัชนี

ดัชนี Cloud Firestore เปิดใช้การค้นหาที่เรียบง่ายและซับซ้อนในเอกสารในฐานข้อมูล

การแสดง JSON 
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อที่เซิร์ฟเวอร์กำหนดสำหรับดัชนีนี้ รูปแบบของชื่อนี้สำหรับดัชนีผสมจะเป็น: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} สำหรับดัชนีช่องเดี่ยว ฟิลด์นี้จะว่างเปล่า
queryScope

enum (QueryScope)

ดัชนีที่มีขอบเขตการค้นหาคอลเล็กชันจะอนุญาตการค้นหากับคอลเล็กชันซึ่งเป็นรายการย่อยของเอกสารที่ระบุ ณ เวลาค้นหา และมีรหัสคอลเล็กชันเดียวกัน

ดัชนีที่มีขอบเขตการค้นหากลุ่มคอลเล็กชันระบุไว้จะอนุญาตการค้นหากับคอลเล็กชันทั้งหมดที่สืบทอดมาจากเอกสารเฉพาะ ซึ่งระบุ ณ เวลาค้นหา และมีรหัสคอลเล็กชันเดียวกับดัชนีนี้
apiScope

enum (ApiScope)

ขอบเขต API ที่ดัชนีนี้รองรับ
fields[]

object (IndexField)

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

สำหรับดัชนีผสม จะต้องมีช่องอย่างน้อย 2 ช่องและสูงสุด 100 ช่อง รายการช่องสุดท้ายจะเป็นรายการสำหรับเส้นทางช่อง __name__ เสมอ หากไม่ได้ระบุ __name__ เป็นช่องสุดท้ายตั้งแต่ตอนสร้าง ระบบจะเพิ่มช่องดังกล่าวโดยอัตโนมัติในทิศทางเดียวกับช่องสุดท้ายที่กำหนดให้ หากช่องสุดท้ายในดัชนีผสมไม่มีการกำหนดทิศทาง ระบบจะเรียงลำดับ __name__ เป็น ASCENDING (ยกเว้นที่ระบุอย่างชัดเจน)

สำหรับดัชนีช่องเดียว รายการนี้จะเป็น 1 รายการที่มีเส้นทางฟิลด์เท่ากับเส้นทางช่องของช่องที่เกี่ยวข้องเสมอ
state

enum (State)

เอาต์พุตเท่านั้น สถานะการแสดงผลของดัชนี

IndexField

ฟิลด์ในดัชนี FieldPath จะอธิบายฟิลด์ที่มีการจัดทำดัชนี ส่วน value_mode จะอธิบายถึงวิธีการจัดทำดัชนีของค่าฟิลด์

การแสดง JSON 
{
  "fieldPath": string,

  // Union field value_mode can be only one of the following:
  "order": enum (Order),
  "arrayConfig": enum (ArrayConfig),
  "vectorConfig": {
    object (VectorConfig)
  }
  // End of list of possible types for union field value_mode.
}
ช่อง
fieldPath

string

อาจเป็น name สำหรับดัชนีช่องเดี่ยว ค่านี้ต้องตรงกับชื่อช่อง มิฉะนั้นระบบอาจละเว้น
ฟิลด์สหภาพ value_mode วิธีจัดทำดัชนีค่าในช่อง value_mode ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
order

enum (Order)

ระบุว่าช่องนี้รองรับการเรียงลำดับตามที่ระบุ หรือเปรียบเทียบโดยใช้ =, !=, <, <=, >, >=
arrayConfig

enum (ArrayConfig)

ระบุว่าช่องนี้รองรับการดำเนินการใน arrayValue
vectorConfig

object (VectorConfig)

ระบุว่าฟิลด์นี้สนับสนุนเพื่อนบ้านที่ใกล้ที่สุดและการดําเนินการระยะทางบนเวกเตอร์

VectorConfig

การกำหนดค่าดัชนีเพื่อสนับสนุนการดำเนินการค้นหาเวกเตอร์

การแสดง JSON 
{
  "dimension": integer,

  // Union field type can be only one of the following:
  "flat": {
    object (FlatIndex)
  }
  // End of list of possible types for union field type.
}
ช่อง
dimension

integer

ต้องระบุ มิติข้อมูลเวกเตอร์ที่ใช้การกำหนดค่านี้

ดัชนีที่ได้จะรวมเฉพาะเวกเตอร์ของมิติข้อมูลนี้เท่านั้น และสามารถใช้สำหรับการค้นหาเวกเตอร์ที่มีมิติข้อมูลเดียวกันได้
ฟิลด์สหภาพ type ประเภทดัชนีที่ใช้ type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
flat

object (FlatIndex)

บ่งบอกว่าดัชนีเวกเตอร์เป็นดัชนีค่าคงที่

FlatIndex

ประเภทนี้ไม่มีช่อง

ดัชนีที่จัดเก็บเวกเตอร์ในโครงสร้างข้อมูลแบบแฟลต และรองรับการค้นหาอย่างละเอียด

TtlConfigDelta

ข้อมูลเกี่ยวกับการเปลี่ยนแปลงการกำหนดค่า TTL

การแสดง JSON 
{
  "changeType": enum (ChangeType)
}
ช่อง
changeType

enum (ChangeType)

ระบุการเปลี่ยนแปลงการกำหนดค่า TTL