Package google.firestore.admin.v1beta2

ดัชนี

FirestoreAdmin

การดำเนินการสร้างขึ้นโดยบริการ FirestoreAdmin แต่จะเข้าถึงผ่านบริการ google.longrunning.Operations

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

สร้างดัชนีผสม การดำเนินการนี้จะแสดงผล google.longrunning.Operation ซึ่งอาจใช้เพื่อติดตามสถานะของการสร้าง ข้อมูลเมตาสำหรับการดำเนินการจะเป็นประเภท IndexOperationMetadata

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

ลบดัชนีผสม

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
ExportDocuments

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

ส่งออกสำเนาเอกสารทั้งหมดหรือบางส่วนจาก Google Cloud Firestore ไปยังระบบพื้นที่เก็บข้อมูลอื่น เช่น Google Cloud Storage การอัปเดตเอกสารล่าสุดอาจไม่แสดงในการส่งออก การส่งออกจะเกิดขึ้นในเบื้องหลัง รวมทั้งสามารถตรวจสอบและจัดการความคืบหน้าได้ผ่านทรัพยากรการดำเนินการที่สร้างขึ้น เอาต์พุตของการส่งออกจะใช้ได้เฉพาะเมื่อดำเนินการที่เกี่ยวข้องเสร็จแล้วเท่านั้น หากยกเลิกการดำเนินการส่งออกก่อนดำเนินการเสร็จสิ้น การดำเนินการส่งออกอาจทิ้งข้อมูลบางส่วนไว้ใน Google Cloud Storage

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
GetField

rpc GetField(GetFieldRequest) returns (Field)

รับข้อมูลเมตาและการกำหนดค่าสำหรับช่อง

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

รับดัชนีผสม

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
ImportDocuments

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

นำเข้าเอกสารไปยัง Google Cloud Firestore ระบบจะเขียนทับเอกสารที่มีอยู่แล้วซึ่งมีชื่อเดียวกัน การนำเข้าจะเกิดขึ้นในเบื้องหลัง รวมทั้งสามารถตรวจสอบและจัดการความคืบหน้าได้ผ่านทรัพยากรการดำเนินการที่สร้างขึ้น หากยกเลิกการดำเนินการ ImportDocuments อาจเป็นไปได้ว่ามีการนำเข้าข้อมูลชุดย่อยไปยัง Cloud Firestore แล้ว

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
ListFields

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

แสดงรายการการกำหนดค่าช่องและข้อมูลเมตาสำหรับฐานข้อมูลนี้

ขณะนี้ FirestoreAdmin.ListFields รองรับเฉพาะช่องรายการที่ถูกลบล้างอย่างชัดเจนเท่านั้น หากต้องการออกการค้นหานี้ โปรดเรียกใช้ FirestoreAdmin.ListFields พร้อมตั้งค่าตัวกรองเป็น indexConfig.usesAncestorConfig:false

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

แสดงรายการดัชนีผสม

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
UpdateField

rpc UpdateField(UpdateFieldRequest) returns (Operation)

อัปเดตการกำหนดค่าช่อง ปัจจุบันการอัปเดตช่องจะใช้กับการกำหนดค่าดัชนีช่องเดียวเท่านั้น อย่างไรก็ตาม การเรียกใช้ไปยัง FirestoreAdmin.UpdateField ควรมีการมาสก์เพื่อหลีกเลี่ยงไม่ให้มีการเปลี่ยนแปลงการกําหนดค่าที่ผู้โทรไม่ทราบ ฟิลด์มาสก์ควรระบุเป็น: { paths: "index_config" }

การเรียกนี้จะแสดง google.longrunning.Operation ซึ่งอาจใช้เพื่อติดตามสถานะของการอัปเดตในฟิลด์นี้ ข้อมูลเมตาสำหรับการดำเนินการจะเป็นประเภท FieldOperationMetadata

ในการกำหนดการตั้งค่าฟิลด์เริ่มต้นสำหรับฐานข้อมูล ให้ใช้ Field พิเศษพร้อมด้วยชื่อทรัพยากร: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์

CreateIndexRequest

คำขอสำหรับ FirestoreAdmin.CreateIndex

ช่อง
parent

string

ชื่อหลักของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
index

Index

ดัชนีผสมที่จะสร้าง

DeleteIndexRequest

คำขอสำหรับ FirestoreAdmin.DeleteIndex

ช่อง
name

string

ชื่อของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ExportDocumentsMetadata

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

ช่อง
start_time

Timestamp

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

Timestamp

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

OperationState

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

Progress

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

Progress

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

string

รหัสคอลเล็กชันที่กำลังส่งออก
output_uri_prefix

string

ตำแหน่งที่มีการส่งออกเอนทิตี

ExportDocumentsRequest

คำขอสำหรับ FirestoreAdmin.ExportDocuments

ช่อง
name

string

ฐานข้อมูลที่จะส่งออก ควรอยู่ในรูปแบบ projects/{project_id}/databases/{database_id}
collection_ids[]

string

รหัสคอลเล็กชันที่จะส่งออก ไม่ระบุ หมายถึงคอลเล็กชันทั้งหมด
output_uri_prefix

string

URI เอาต์พุต ขณะนี้รองรับเฉพาะ URI ของ Google Cloud Storage ในรูปแบบ gs://BUCKET_NAME[/NAMESPACE_PATH] โดยที่ BUCKET_NAME เป็นชื่อที่เก็บข้อมูล Google Cloud Storage และ NAMESPACE_PATH เป็นเส้นทางเนมสเปซของ Google Cloud Storage ที่ไม่บังคับ เมื่อเลือกชื่อ โปรดพิจารณาหลักเกณฑ์การตั้งชื่อของ Google Cloud Storage: https://cloud.google.com/storage/docs/naming หาก URI เป็นที่เก็บข้อมูล (ไม่มีเส้นทางเนมสเปซ) ระบบจะสร้างคำนำหน้าโดยอิงตามเวลาเริ่มต้น

ExportDocumentsResponse

แสดงผลในช่องคำตอบ google.longrunning.Operation

ช่อง
output_uri_prefix

string

ตำแหน่งของไฟล์เอาต์พุต ซึ่งอาจใช้เพื่อเริ่มการนำเข้าไปยัง Cloud Firestore (โปรเจ็กต์นี้หรือโปรเจ็กต์อื่น) หลังจากที่การดำเนินการเสร็จสมบูรณ์ได้

ฟิลด์

แสดงฟิลด์เดียวในฐานข้อมูล

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

ช่อง
name

string

ชื่อช่องของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

เส้นทางของฟิลด์อาจเป็นชื่อฟิลด์ง่ายๆ เช่น address หรือเส้นทางไปยังฟิลด์ภายในmap_value เช่น 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/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* ดัชนีที่กำหนดไว้ใน Field นี้จะใช้กับทุกช่องที่ไม่มีการกำหนดค่าดัชนี Field เป็นของตัวเอง
index_config

IndexConfig

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

IndexConfig

การกำหนดค่าดัชนีสำหรับช่องนี้

ช่อง
indexes[]

Index

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

bool

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

string

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

bool

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

FieldOperationMetadata

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

ช่อง
start_time

Timestamp

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

Timestamp

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

string

ทรัพยากรฟิลด์ที่การดำเนินการนี้ดำเนินการ เช่น projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
index_config_deltas[]

IndexConfigDelta

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

OperationState

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

Progress

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

Progress

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

IndexConfigDelta

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

ช่อง
change_type

ChangeType

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

Index

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

ChangeType

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

Enum
CHANGE_TYPE_UNSPECIFIED ไม่ได้ระบุหรือไม่ทราบประเภทของการเปลี่ยนแปลง
ADD กำลังเพิ่มดัชนีช่องเดี่ยว
REMOVE เรากำลังนำดัชนีช่องเดียวออก

GetFieldRequest

คำขอสำหรับ FirestoreAdmin.GetField

ช่อง
name

string

ชื่อของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

GetIndexRequest

คำขอสำหรับ FirestoreAdmin.GetIndex

ช่อง
name

string

ชื่อของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ImportDocumentsMetadata

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

ช่อง
start_time

Timestamp

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

Timestamp

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

OperationState

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

Progress

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

Progress

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

string

รหัสคอลเล็กชันที่กำลังนำเข้า
input_uri_prefix

string

ตำแหน่งของเอกสารที่จะนำเข้า

ImportDocumentsRequest

คำขอสำหรับ FirestoreAdmin.ImportDocuments

ช่อง
name

string

ฐานข้อมูลที่จะนำเข้า ควรอยู่ในรูปแบบ projects/{project_id}/databases/{database_id}
collection_ids[]

string

รหัสคอลเล็กชันที่จะนำเข้า ไม่ระบุ หมายถึงคอลเล็กชันทั้งหมดที่รวมอยู่ในการนำเข้า
input_uri_prefix

string

ตำแหน่งของไฟล์ที่ส่งออก ค่านี้ต้องตรงกับ export_uri_prefix ของ ExportDocumentsResponse จากการส่งออกที่เสร็จสมบูรณ์ โปรดดูgoogle.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix

ดัชนี

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

ช่อง
name

string

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

QueryScope

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

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

IndexField

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

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

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

State

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

IndexField

ฟิลด์ในดัชนี

ช่อง
field_path

string

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

Order

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

ArrayConfig

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

ArrayConfig

การกำหนดค่าอาร์เรย์ที่รองรับ

Enum
ARRAY_CONFIG_UNSPECIFIED ดัชนีไม่รองรับการค้นหาอาร์เรย์เพิ่มเติม
CONTAINS ดัชนีรองรับการค้นหาที่มีอาร์เรย์

สั่งซื้อ

ลำดับที่รองรับ

Enum
ORDER_UNSPECIFIED ไม่ได้ระบุลำดับ ไม่ใช่ตัวเลือกที่ถูกต้อง
ASCENDING ระบบจะเรียงลำดับช่องนี้ตามค่าจากน้อยไปมาก
DESCENDING ระบบจะเรียงลำดับช่องนี้ตามค่าของช่องจากมากไปน้อย

QueryScope

ขอบเขตการค้นหาจะกำหนดขอบเขตที่เรียกใช้การค้นหา ซึ่งระบุในช่อง from ของ StructuredQuery

Enum
QUERY_SCOPE_UNSPECIFIED ไม่ได้ระบุขอบเขตการค้นหา ไม่ใช่ตัวเลือกที่ถูกต้อง
COLLECTION ดัชนีที่มีขอบเขตการค้นหาคอลเล็กชันที่ระบุจะอนุญาตการค้นหากับคอลเล็กชันซึ่งเป็นรายการย่อยของเอกสารที่ระบุ ณ เวลาค้นหา และมีรหัสคอลเล็กชันที่ระบุโดยดัชนี
COLLECTION_GROUP ดัชนีที่มีขอบเขตการค้นหากลุ่มคอลเล็กชันระบุไว้จะอนุญาตการค้นหากับคอลเล็กชันทั้งหมดที่มีรหัสคอลเล็กชันที่ระบุโดยดัชนี

รัฐ

สถานะของดัชนี ในระหว่างการสร้างดัชนี ดัชนีจะอยู่ในสถานะ CREATING หากสร้างดัชนีเรียบร้อยแล้ว ดัชนีจะเปลี่ยนเป็นสถานะ READY หากการสร้างดัชนีพบปัญหา ดัชนีจะเปลี่ยนเป็นสถานะ NEEDS_REPAIR

Enum
STATE_UNSPECIFIED ไม่ได้ระบุรัฐ
CREATING กำลังสร้างดัชนี มีการดำเนินการที่ใช้เวลานานสำหรับดัชนีที่ใช้งานอยู่ ดัชนีจะมีการอัปเดตเมื่อเขียนเอกสาร อาจมีข้อมูลดัชนีบางอย่างอยู่
READY ดัชนีพร้อมใช้งานแล้ว ดัชนีจะมีการอัปเดตเมื่อเขียนเอกสาร ระบบจะป้อนข้อมูลดัชนีทั้งหมดจากเอกสารที่จัดเก็บทั้งหมดที่ใช้
NEEDS_REPAIR กำลังสร้างดัชนี แต่เกิดข้อผิดพลาดขึ้น ไม่มีการดำเนินการแบบระยะยาวที่ดำเนินอยู่สำหรับดัชนี และการดำเนินการที่ใช้เวลานานล่าสุดที่เสร็จสิ้นล้มเหลว ดัชนีไม่อัปเดตเมื่อเขียนเอกสาร อาจมีข้อมูลดัชนีบางอย่างอยู่ ใช้ google.longrunning.Executs API เพื่อหาสาเหตุที่การดำเนินการที่พยายามสร้างดัชนีนี้ล้มเหลวครั้งล่าสุด จากนั้นจึงสร้างดัชนีอีกครั้ง

IndexOperationMetadata

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

ช่อง
start_time

Timestamp

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

Timestamp

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

string

ทรัพยากรดัชนีที่การดำเนินการนี้ดำเนินการอยู่ เช่น projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
state

OperationState

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

Progress

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

Progress

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

ListFieldsRequest

คำขอสำหรับ FirestoreAdmin.ListFields

ช่อง
parent

string

ชื่อหลักของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

ตัวกรองที่จะนำไปใช้กับผลการค้นหา ขณะนี้ FirestoreAdmin.ListFields รองรับเฉพาะช่องรายการที่ถูกลบล้างอย่างชัดเจนเท่านั้น หากต้องการออกการค้นหานี้ โปรดเรียกใช้ FirestoreAdmin.ListFields พร้อมตั้งค่าตัวกรองเป็น indexConfig.usesAncestorConfig:false
page_size

int32

จำนวนผลลัพธ์ที่จะแสดงผล
page_token

string

โทเค็นของหน้าที่ส่งคืนจากการเรียกไปยัง FirestoreAdmin.ListFields ครั้งก่อน ซึ่งอาจใช้ในการรับผลการค้นหาหน้าถัดไป

ListFieldsResponse

การตอบกลับสำหรับ FirestoreAdmin.ListFields

ช่อง
fields[]

Field

ฟิลด์ที่ขอ
next_page_token

string

โทเค็นของหน้าที่อาจใช้เพื่อขอหน้าผลลัพธ์อื่น หากเว้นว่างไว้ นี่คือหน้าสุดท้าย

ListIndexesRequest

คำขอสำหรับ FirestoreAdmin.ListIndexes

ช่อง
parent

string

ชื่อหลักของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

ตัวกรองที่จะนำไปใช้กับผลการค้นหา
page_size

int32

จำนวนผลลัพธ์ที่จะแสดงผล
page_token

string

โทเค็นของหน้าที่ส่งคืนจากการเรียกไปยัง FirestoreAdmin.ListIndexes ครั้งก่อน ซึ่งอาจใช้ในการรับผลการค้นหาหน้าถัดไป

ListIndexesResponse

การตอบกลับสำหรับ FirestoreAdmin.ListIndexes

ช่อง
indexes[]

Index

ดัชนีที่ขอ
next_page_token

string

โทเค็นของหน้าที่อาจใช้เพื่อขอหน้าผลลัพธ์อื่น หากเว้นว่างไว้ นี่คือหน้าสุดท้าย

OperationState

อธิบายสถานะของการดำเนินการ

Enum
OPERATION_STATE_UNSPECIFIED ไม่ระบุ
INITIALIZING ระบบกำลังเตรียมการดำเนินการตามคำขอ
PROCESSING กำลังดำเนินการกับคำขอ
CANCELLING คำขออยู่ระหว่างกระบวนการจะถูกยกเลิกหลังจากที่ผู้ใช้ชื่อ google.longrunning.Implements.CancelOperating ในการดำเนินการนี้
FINALIZING คำขอได้รับการดำเนินการแล้ว และอยู่ในระยะขั้นสุดท้าย
SUCCESSFUL คำขอเสร็จสมบูรณ์
FAILED ประมวลผลคำขอเสร็จสิ้นแล้ว แต่พบข้อผิดพลาด
CANCELLED ยกเลิกคำขอเสร็จสมบูรณ์หลังจากที่ผู้ใช้ชื่อ google.longrunning.ActionssCancelExecut ดำเนินการ

ความคืบหน้า

อธิบายความคืบหน้าของการดำเนินการ หน่วยงานเป็นหน่วยทั่วไปและต้องตีความตามสถานที่ที่ใช้ Progress

ช่อง
estimated_work

int64

จำนวนงานที่ประมาณไว้
completed_work

int64

จำนวนงานที่ทำเสร็จแล้ว

UpdateFieldRequest

คำขอสำหรับ FirestoreAdmin.UpdateField

ช่อง
field

Field

ฟิลด์ที่จะอัปเดต
update_mask

FieldMask

มาสก์ที่สัมพันธ์กับฟิลด์ หากระบุไว้ ระบบจะอัปเดตเฉพาะการกำหนดค่าที่ระบุโดย field_mask นี้ในช่อง