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__ เป็นช่องสุดท้ายโดยอัตโนมัติในทิศทางเดียวกันกับช่องสุดท้ายที่กำหนด หากช่องสุดท้ายในดัชนีผสมไม่มีทิศทาง ระบบจะเรียงลำดับ __name__ จาก ASCENDING (เว้นแต่จะระบุอย่างชัดเจน)

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

enum (State)

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

ฟิลด์ดัชนี

ช่องในดัชนี ฟิลด์พาธอธิบายถึงช่องที่มีการจัดทำดัชนี ส่วน 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)

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

การกำหนดค่าเวกเตอร์

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

การแสดง 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)

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

ดัชนีคงที่

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

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

การกำหนดค่าเดลต้า

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

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

enum (ChangeType)

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