Package google.firestore.admin.v1

ดัชนี

ผู้ดูแลระบบ Firestore

Cloud Firestore Admin API

API นี้ให้บริการดูแลระบบหลายอย่างสำหรับ Cloud Firestore

มีการใช้โปรเจ็กต์ ฐานข้อมูล เนมสเปซ คอลเล็กชัน กลุ่มคอลเล็กชัน และเอกสารตามที่ระบุไว้ใน Google Cloud Firestore API

การดำเนินการ: การดำเนินการแสดงถึงงานที่กำลังดำเนินการอยู่ในเบื้องหลัง

บริการดัชนีจัดการดัชนี Cloud Firestore

การสร้างดัชนีจะดำเนินการไม่พร้อมกัน ทรัพยากรการดำเนินการจะสร้างขึ้นสำหรับการดำเนินการแบบไม่พร้อมกันแต่ละรายการ คุณสามารถค้นหาสถานะของการดำเนินการ (รวมถึงข้อผิดพลาดที่พบ) ได้ผ่านทรัพยากรการดำเนินการ

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

การดำเนินการที่เสร็จสิ้นแล้วอาจถูกลบเพื่อไม่ให้แสดงเป็นส่วนหนึ่งของคอลเล็กชันการดำเนินการอีกต่อไป การดำเนินการคือถังขยะหลังจาก 30 วัน โดยค่าเริ่มต้น ListOperations จะส่งกลับเฉพาะการดำเนินการที่กำลังดำเนินการและล้มเหลวเท่านั้น หากต้องการแสดงรายการการดำเนินการที่เสร็จสมบูรณ์ ให้ส่งคำขอ ListOperations ที่มีตัวกรอง done: true

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

สร้างกำหนดการสำรอง

rpc CreateBackupSchedule(CreateBackupScheduleRequest) returns (BackupSchedule)

สร้างกำหนดการสำรองข้อมูลบนฐานข้อมูล โดยกำหนดค่ากำหนดการสำรองข้อมูลได้สูงสุด 2 รายการในฐานข้อมูล โดยกำหนดเวลาการสำรองข้อมูลรายวัน 1 รายการ และกำหนดเวลาการสำรองข้อมูลรายสัปดาห์ 1 รายการ

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
สร้างฐานข้อมูล

rpc CreateDatabase(CreateDatabaseRequest) returns (Operation)

สร้างฐานข้อมูล

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

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

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
ลบข้อมูลสำรอง

rpc DeleteBackup(DeleteBackupRequest) returns (Empty)

ลบข้อมูลสำรอง

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
ลบข้อมูลสำรอง

rpc DeleteBackupSchedule(DeleteBackupScheduleRequest) returns (Empty)

ลบกำหนดการสำรองข้อมูล

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
ลบฐานข้อมูล

rpc DeleteDatabase(DeleteDatabaseRequest) returns (Operation)

ลบฐานข้อมูล

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
ลบดัชนี

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

ลบดัชนีผสม

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
ส่งออกเอกสาร

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

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

ดูรายละเอียดเพิ่มเติมเกี่ยวกับพฤติกรรมการส่งออกและรูปแบบเอาต์พุตได้ที่ https://cloud.google.com/firestore/docs/manage-data/export-IMPORT

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
รับข้อมูลสำรอง

rpc GetBackup(GetBackupRequest) returns (Backup)

รับข้อมูลเกี่ยวกับข้อมูลสำรอง

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
รับกำหนดการสำรอง

rpc GetBackupSchedule(GetBackupScheduleRequest) returns (BackupSchedule)

รับข้อมูลเกี่ยวกับกําหนดการสํารองข้อมูล

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
รับฐานข้อมูล

rpc GetDatabase(GetDatabaseRequest) returns (Database)

รับข้อมูลเกี่ยวกับฐานข้อมูล

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
รับฟิลด์

rpc GetField(GetFieldRequest) returns (Field)

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

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
รับดัชนี

rpc GetIndex(GetIndexRequest) returns (Index)

รับดัชนีผสม

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
นำเข้าเอกสาร

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
ListBackupSchedules

rpc ListBackupSchedules(ListBackupSchedulesRequest) returns (ListBackupSchedulesResponse)

แสดงรายการกำหนดเวลาการสำรองข้อมูล

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
สำรองข้อมูลรายการ

rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse)

แสดงรายการข้อมูลสำรองทั้งหมด

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
แสดงรายการฐานข้อมูล

rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse)

แสดงรายการฐานข้อมูลทั้งหมดในโปรเจ็กต์

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
ฟิลด์รายการ

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

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

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

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
ListIndex

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

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

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
กู้คืนฐานข้อมูล

rpc RestoreDatabase(RestoreDatabaseRequest) returns (Operation)

สร้างฐานข้อมูลใหม่โดยกู้คืนจากข้อมูลสำรองที่มีอยู่

ฐานข้อมูลใหม่ต้องอยู่ในภูมิภาคระบบคลาวด์หรือตำแหน่งที่ตั้งแบบหลายภูมิภาคเดียวกันกับข้อมูลสำรองที่มีอยู่ ลักษณะการทำงานนี้คล้ายกับ [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] ยกเว้นแทนที่จะสร้างฐานข้อมูลใหม่ที่ว่างเปล่า ระบบจะสร้างฐานข้อมูลใหม่ด้วยประเภทฐานข้อมูล การกำหนดค่าดัชนี และเอกสารจากข้อมูลสำรองที่มีอยู่

long-running operation สามารถใช้เพื่อติดตามความคืบหน้าของการกู้คืน โดยประเภทช่อง metadata ของการดำเนินการเป็น RestoreDatabaseMetadata ประเภท response คือ Database หากกู้คืนสำเร็จ ฐานข้อมูลใหม่จะไม่สามารถอ่านหรือเขียนได้จนกว่า LRO จะเสร็จสมบูรณ์

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
อัปเดตกำหนดการสำรอง

rpc UpdateBackupSchedule(UpdateBackupScheduleRequest) returns (BackupSchedule)

อัปเดตกำหนดการสำรองข้อมูล

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
อัปเดตฐานข้อมูล

rpc UpdateDatabase(UpdateDatabaseRequest) returns (Operation)

อัปเดตฐานข้อมูล

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์
ฟิลด์อัปเดต

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

สำหรับข้อมูลเพิ่มเติม โปรดดูภาพรวมการตรวจสอบสิทธิ์

แหล่งข้อมูลสำรอง

ข้อมูลสำรองของฐานข้อมูล Cloud Firestore

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

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรที่ไม่ซ้ำกันของข้อมูลสำรอง

รูปแบบคือ projects/{project}/locations/{location}/backups/{backup}
database

string

เอาต์พุตเท่านั้น ชื่อฐานข้อมูล Firestore ที่เป็นข้อมูลสำรอง

รูปแบบคือ projects/{project}/databases/{database}
database_uid

string

เอาต์พุตเท่านั้น UUID4 ที่ระบบสร้างขึ้นสำหรับฐานข้อมูล Firestore ซึ่งเป็นแหล่งที่มาของข้อมูลสำรอง
snapshot_time

Timestamp

เอาต์พุตเท่านั้น ในขณะนี้ ข้อมูลสำรองจะมีสำเนาฐานข้อมูลที่สอดคล้องกันภายนอก
expire_time

Timestamp

เอาต์พุตเท่านั้น การประทับเวลาที่ข้อมูลสำรองนี้หมดอายุ
state

State

เอาต์พุตเท่านั้น สถานะปัจจุบันของข้อมูลสำรอง

รัฐ

ระบุสถานะปัจจุบันของข้อมูลสำรอง

Enum
STATE_UNSPECIFIED ไม่ได้ระบุรัฐ
CREATING กำลังสร้างข้อมูลสำรองที่รอดำเนินการ การดำเนินการในข้อมูลสำรองจะถูกปฏิเสธในสถานะนี้
READY การสำรองข้อมูลเสร็จสมบูรณ์และพร้อมใช้งานแล้ว
NOT_AVAILABLE การสำรองข้อมูลไม่พร้อมใช้งานในขณะนี้

กำหนดการสำรองข้อมูล

กำหนดการสำรองข้อมูลสำหรับฐานข้อมูล Cloud Firestore

ทรัพยากรนี้เป็นของฐานข้อมูลที่กำลังสำรองข้อมูล และถูกลบไปพร้อมกับฐานข้อมูล แต่ข้อมูลจริงไม่ใช่ข้อมูลสำรอง

ช่อง
name

string

เอาต์พุตเท่านั้น ตัวระบุกำหนดเวลาการสำรองข้อมูลที่ไม่ซ้ำกันในตำแหน่งและฐานข้อมูลทั้งหมดสำหรับโปรเจ็กต์ที่ระบุ

ซึ่งระบบจะกำหนดให้โดยอัตโนมัติ

รูปแบบคือ projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
create_time

Timestamp

เอาต์พุตเท่านั้น การประทับเวลาที่สร้างกำหนดการสำรองข้อมูลและมีผลตั้งแต่นั้น

ระบบจะไม่สร้างข้อมูลสำรองสำหรับกำหนดการนี้ก่อนเวลานี้
update_time

Timestamp

เอาต์พุตเท่านั้น การประทับเวลาที่อัปเดตกำหนดการสำรองนี้ครั้งล่าสุด เมื่อมีการสร้างกำหนดการสำรองข้อมูลเป็นครั้งแรก ระยะเวลานี้จะเหมือนกับ create_time
retention

Duration

ในเวลาที่สัมพันธ์กันในอนาคต เมื่อเทียบกับเวลาที่สร้างข้อมูลสำรอง คุณควรลบข้อมูลสำรอง เช่น เก็บข้อมูลสำรองเป็นเวลา 7 วัน

ระยะเวลาเก็บรักษาสูงสุดที่รองรับคือ 14 สัปดาห์
ช่องการรวม recurrence ฟิลด์หนึ่งที่ใช้แสดงเวลาที่จะสำรองข้อมูล recurrence ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
daily_recurrence

DailyRecurrence

สำหรับกำหนดการที่ทำงานทุกวัน
weekly_recurrence

WeeklyRecurrence

สำหรับกำหนดการที่ทำงานทุกสัปดาห์ในวันที่ที่ระบุ

สร้างคำขอกำหนดเวลาสำรอง

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

ช่อง
parent

string

ต้องระบุ ฐานข้อมูลหลัก

ฟอร์แมต projects/{project}/databases/{database}
backup_schedule

BackupSchedule

ต้องระบุ กําหนดการสํารองข้อมูลที่จะสร้าง

CreateDatabaseMetadata

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

ข้อมูลเมตาที่เกี่ยวข้องกับการดำเนินการสร้างฐานข้อมูล

CreateDatabaseRequest (คำขอสร้างฐานข้อมูล)

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

ช่อง
parent

string

ต้องระบุ ชื่อระดับบนสุดของแบบฟอร์ม projects/{project_id}
database

Database

ต้องระบุ ฐานข้อมูลที่จะสร้าง
database_id

string

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

ค่านี้ควรมีความยาว 4-63 อักขระ อักขระที่ใช้ได้คือ /[a-z][0-9]-/ โดยขึ้นต้นด้วยตัวอักษรและสุดท้ายเป็นตัวอักษรหรือตัวเลข ต้องไม่อยู่ในรูปแบบ UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/

"(ค่าเริ่มต้น)" รหัสฐานข้อมูลก็ถูกต้องเช่นกัน

CreateIndexRequest

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

ช่อง
parent

string

ต้องระบุ ชื่อระดับบนสุดของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
index

Index

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

การเกิดซ้ำรายวัน

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

หมายถึงกำหนดการที่เกิดซ้ำซึ่งทํางานทุกวัน

ใช้เขตเวลา UTC

ฐานข้อมูล

ฐานข้อมูล Cloud Firestore

ช่อง
name

string

ชื่อทรัพยากรของฐานข้อมูล รูปแบบ: projects/{project}/databases/{database}
uid

string

เอาต์พุตเท่านั้น UUID4 ที่ระบบสร้างขึ้นสำหรับฐานข้อมูลนี้
create_time

Timestamp

เอาต์พุตเท่านั้น การประทับเวลาที่ใช้สร้างฐานข้อมูลนี้ ฐานข้อมูลที่สร้างก่อนปี 2016 จะไม่ป้อนข้อมูล create_time
update_time

Timestamp

เอาต์พุตเท่านั้น การประทับเวลาที่ฐานข้อมูลนี้ได้รับการอัปเดตล่าสุด โปรดทราบว่าการอัปเดตนี้รวมเฉพาะการอัปเดตทรัพยากรฐานข้อมูลเท่านั้น ไม่รวมข้อมูลที่อยู่ในฐานข้อมูล
delete_time

Timestamp

เอาต์พุตเท่านั้น การประทับเวลาที่มีการลบฐานข้อมูลนี้ ตั้งค่าเฉพาะเมื่อฐานข้อมูลถูกลบไปแล้ว
location_id

string

ตำแหน่งของฐานข้อมูล ตำแหน่งที่พร้อมใช้งานจะแสดงอยู่ใน https://cloud.google.com/firestore/docs/locations
type

DatabaseType

ประเภทของฐานข้อมูล ดูข้อมูลเกี่ยวกับวิธีเลือกได้ใน https://cloud.google.com/datastore/docs/firestore-or-datastore
concurrency_mode

ConcurrencyMode

โหมดควบคุมการเกิดขึ้นพร้อมกันที่ใช้สำหรับฐานข้อมูลนี้
version_retention_period

Duration

เอาต์พุตเท่านั้น ระยะเวลาในระหว่างที่มีการเก็บรักษาข้อมูลเวอร์ชันที่ผ่านมาไว้ในฐานข้อมูล

read หรือ query สามารถระบุ read_time ภายในหน้าต่างนี้ได้ และจะอ่านสถานะของฐานข้อมูลในขณะนั้น

หากเปิดใช้งานฟีเจอร์ PITR แล้ว ระยะเวลาเก็บรักษาคือ 7 วัน มิฉะนั้น ระยะเวลาเก็บรักษาคือ 1 ชั่วโมง
earliest_version_time

Timestamp

เอาต์พุตเท่านั้น การประทับเวลาแรกสุดที่สามารถอ่านข้อมูลเวอร์ชันเก่าจากฐานข้อมูลได้ ดู [version_retention_period] ด้านบน ฟิลด์นี้จะเติมด้วย now - version_retention_period

ค่านี้จะได้รับการอัปเดตอย่างต่อเนื่อง และจะไม่มีการอัปเดตทันทีที่มีการค้นหา หากคุณใช้ค่านี้เพื่อกู้คืนข้อมูล อย่าลืมพิจารณาช่วงเวลานับตั้งแต่ที่มีการค้นหาค่าจนถึงตอนที่คุณเริ่มการกู้คืน
point_in_time_recovery_enablement

PointInTimeRecoveryEnablement

จะเปิดใช้ฟีเจอร์ PITR บนฐานข้อมูลนี้หรือไม่
app_engine_integration_mode

AppEngineIntegrationMode

โหมดการผสานรวมของ App Engine ที่จะใช้สำหรับฐานข้อมูลนี้
key_prefix

string

เอาต์พุตเท่านั้น key_prefix สำหรับฐานข้อมูลนี้ key_prefix นี้ใช้ร่วมกับรหัสโปรเจ็กต์ ("~") เพื่อสร้างรหัสแอปพลิเคชันที่ส่งคืนจาก API ของ Cloud Datastore ในรันไทม์รุ่นแรกของ Google App Engine

ค่านี้อาจว่างเปล่าในกรณีที่ appid ที่จะใช้สำหรับคีย์ที่เข้ารหัส URL คือ project_id (เช่น foo แทน v~foo)
delete_protection_state

DeleteProtectionState

สถานะของการป้องกันการลบสำหรับฐานข้อมูล
cmek_config

CmekConfig

ไม่บังคับ การตรวจหาบุคคลในบ้านหมายความว่ามีการเปิดใช้ CMEK สำหรับฐานข้อมูลนี้
previous_id

string

เอาต์พุตเท่านั้น รหัสฐานข้อมูลก่อนหน้าของทรัพยากรฐานข้อมูล ช่องนี้จะป้อนข้อมูลสำหรับฐานข้อมูลที่ถูกลบเท่านั้น
etag

string

เซิร์ฟเวอร์จะคำนวณการตรวจสอบข้อผิดพลาดดังกล่าวโดยอิงตามค่าฟิลด์อื่นๆ และอาจส่งคำขออัปเดตและลบคำขอเพื่อให้แน่ใจว่าไคลเอ็นต์มีค่าเป็นปัจจุบันก่อนดำเนินการต่อ

โหมดการผสานรวม App Engine

ประเภทของโหมดการผสานรวมของ App Engine

Enum
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED ไม่ใช้
ENABLED หากมีแอปพลิเคชัน App Engine อยู่ในภูมิภาคเดียวกับฐานข้อมูลนี้ การกำหนดค่า App Engine จะมีผลต่อฐานข้อมูลนี้ ซึ่งรวมถึงการปิดใช้แอปพลิเคชันและ ฐานข้อมูล รวมทั้งปิดการเขียนฐานข้อมูล
DISABLED

App Engine ไม่มีผลต่อความสามารถของฐานข้อมูลนี้ในการดำเนินการตามคำขอ

การตั้งค่านี้เป็นการตั้งค่าเริ่มต้นสำหรับฐานข้อมูลที่สร้างด้วย Firestore API

CmekConfig

การกำหนดค่า CMEK (คีย์การเข้ารหัสที่จัดการโดยลูกค้า) สำหรับฐานข้อมูล Firestore หากไม่มี ฐานข้อมูลจะได้รับการปกป้องโดยคีย์การเข้ารหัสเริ่มต้นของ Google

ช่อง
kms_key_name

string

ต้องระบุ เฉพาะคีย์ในตำแหน่งเดียวกับฐานข้อมูลนี้เท่านั้นที่ได้รับอนุญาตให้ใช้ในการเข้ารหัส

สําหรับหลายภูมิภาค nam5 ของ Firestore จะตรงกับหลายภูมิภาคใน Cloud KMS สำหรับ eur3 ในหลายภูมิภาคของ Firestore จะเป็นไปตามหลายภูมิภาคในยุโรปของ Cloud KMS ดู https://cloud.google.com/kms/docs/locations

รูปแบบที่คาดไว้คือ projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
active_key_version[]

string

เอาต์พุตเท่านั้น เวอร์ชันคีย์ KMS ที่ใช้งานอยู่ในปัจจุบัน ในระหว่างการหมุนเวียนคีย์ อาจมีเวอร์ชันคีย์ที่ใช้งานอยู่ได้หลายเวอร์ชัน

รูปแบบที่คาดไว้คือ projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}

โหมดการเกิดขึ้นพร้อมกัน

ประเภทโหมดควบคุมการเกิดขึ้นพร้อมกันสำหรับธุรกรรม

Enum
CONCURRENCY_MODE_UNSPECIFIED ไม่ใช้
OPTIMISTIC ใช้การควบคุมการเกิดขึ้นพร้อมกันอย่างมีประสิทธิภาพโดยค่าเริ่มต้น โหมดนี้ใช้ได้กับฐานข้อมูล Cloud Firestore
PESSIMISTIC

ใช้การควบคุมการเกิดขึ้นพร้อมกันแบบถาวรโดยค่าเริ่มต้น โหมดนี้ใช้ได้กับฐานข้อมูล Cloud Firestore

นี่คือการตั้งค่าเริ่มต้นสำหรับ Cloud Firestore
OPTIMISTIC_WITH_ENTITY_GROUPS

ใช้การควบคุมการเกิดขึ้นพร้อมกันอย่างมีประสิทธิภาพกับกลุ่มเอนทิตีโดยค่าเริ่มต้น

Cloud Datastore เป็นโหมดเดียวที่ใช้ได้

โหมดนี้ยังใช้กับ Cloud Firestore ที่มีโหมด Datastore ได้ด้วย แต่ไม่แนะนำให้ใช้

ประเภทฐานข้อมูล

ประเภทของฐานข้อมูล ดูข้อมูลเกี่ยวกับวิธีเลือกได้ใน https://cloud.google.com/datastore/docs/firestore-or-datastore

เปลี่ยนโหมดได้ต่อเมื่อฐานข้อมูลว่างเปล่าเท่านั้น

Enum
DATABASE_TYPE_UNSPECIFIED ค่าเริ่มต้น ระบบจะใช้ค่านี้หากไม่มีการระบุประเภทฐานข้อมูล
FIRESTORE_NATIVE โหมดดั้งเดิมของ Firestore
DATASTORE_MODE Firestore ในโหมด Datastore

DeleteProtectionState

สถานะการป้องกันการลบของฐานข้อมูล

Enum
DELETE_PROTECTION_STATE_UNSPECIFIED ค่าเริ่มต้น ไม่ได้ระบุประเภทการป้องกันการลบ
DELETE_PROTECTION_DISABLED ปิดใช้การป้องกันการลบอยู่
DELETE_PROTECTION_ENABLED เปิดใช้การป้องกันการลบอยู่

การเปิดใช้งานการกู้คืน PointInTime

การเปิดใช้ฟีเจอร์การกู้คืนช่วงเวลา

Enum
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED ไม่ใช้
POINT_IN_TIME_RECOVERY_ENABLED

ระบบรองรับการอ่านเวอร์ชันที่เลือกจากในช่วง 7 วันที่ผ่านมา ได้แก่

  • การอ่านเทียบกับการประทับเวลาในชั่วโมงที่ผ่านมา
  • อ่านเทียบกับสแนปชอต 1 นาทีที่เกินจาก 1 ชั่วโมงและภายใน 7 วัน

version_retention_period และ earliest_version_time สามารถใช้เพื่อกำหนดเวอร์ชันที่รองรับ
POINT_IN_TIME_RECOVERY_DISABLED ระบบรองรับการอ่านข้อมูลเวอร์ชันต่างๆ ภายใน 1 ชั่วโมงที่ผ่านมา

ลบข้อมูลสำรอง

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

ช่อง
name

string

ต้องระบุ ชื่อของข้อมูลสำรองที่จะลบ

รูปแบบคือ projects/{project}/locations/{location}/backups/{backup}

DeleteBackupScheduleRequest

คำขอสำหรับ [FirestoreAdmin.DeleteBackupSchedules][]

ช่อง
name

string

ต้องระบุ ชื่อของกำหนดการสำรองข้อมูล

ฟอร์แมต projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

ลบข้อมูลเมตาฐานข้อมูล

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

ข้อมูลเมตาที่เกี่ยวข้องกับการดำเนินการลบฐานข้อมูล

ลบคำขอฐานข้อมูล

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

ช่อง
name

string

ต้องระบุ ชื่อของแบบฟอร์ม projects/{project_id}/databases/{database_id}
etag

string

etag ปัจจุบันของฐานข้อมูล หากระบุ etag ไว้และไม่ตรงกับ etag ปัจจุบันของฐานข้อมูล การลบจะถูกบล็อกและจะแสดงข้อผิดพลาด FAILED_PRECONDITION

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

ที่ที่ส่งออกเอกสารไป
namespace_ids[]

string

รหัสเนมสเปซที่กำลังส่งออก
snapshot_time

Timestamp

การประทับเวลาที่ตรงกับเวอร์ชันของฐานข้อมูลที่กำลังส่งออก หากไม่ระบุ จะไม่สามารถรับประกันความสอดคล้องของเอกสารที่ส่งออกได้

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 เป็นที่เก็บข้อมูล (ไม่มีเส้นทางเนมสเปซ) ระบบจะสร้างคำนำหน้าตามเวลาเริ่มต้น
namespace_ids[]

string

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

องค์ประกอบสตริงว่างเปล่าแสดงเนมสเปซเริ่มต้น ควรใช้แอตทริบิวต์นี้หากฐานข้อมูลมีข้อมูลในเนมสเปซที่ไม่ใช่ค่าเริ่มต้น แต่ไม่ต้องการรวมข้อมูลดังกล่าว เนมสเปซแต่ละรายการในรายการนี้ต้องไม่ซ้ำกัน
snapshot_time

Timestamp

การประทับเวลาที่ตรงกับเวอร์ชันของฐานข้อมูลที่จะส่งออก การประทับเวลาต้องเป็นที่ผ่านมา โดยปัดเศษเป็นนาที และไม่เกิน earliestVersionTime หากระบุ เอกสารที่ส่งออกจะแสดงมุมมองที่สอดคล้องกันของฐานข้อมูล ณ เวลาที่ระบุ ไม่เช่นนั้นก็ไม่สามารถรับประกันความสอดคล้องของเอกสารที่ส่งออกได้

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 กำหนด หากต้องการนำดัชนีทั้งหมดสำหรับช่องนี้ออกอย่างชัดแจ้ง ให้ระบุการกำหนดค่าดัชนีที่มีรายการดัชนีที่ว่างเปล่า
ttl_config

TtlConfig

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

IndexConfig

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

ช่อง
indexes[]

Index

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

bool

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

string

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

bool

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

TtlConfig

การกำหนดค่า TTL (time-to-live) สำหรับเอกสารที่มีการตั้งค่า Field นี้

การจัดเก็บค่าการประทับเวลาลงในช่องที่เปิดใช้ TTL จะถือว่าเป็นเวลาหมดอายุสัมบูรณ์ของเอกสาร ค่าการประทับเวลาที่ผ่านมาบ่งบอกว่าเอกสารมีสิทธิ์หมดอายุทันที การใช้ข้อมูลประเภทอื่นๆ หรือการไม่ระบุช่องจะเป็นการปิดใช้การหมดอายุของเอกสารแต่ละรายการ

ช่อง
state

State

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

รัฐ

สถานะของการใช้การกำหนดค่า TTL กับเอกสารทั้งหมด

Enum
STATE_UNSPECIFIED ไม่ได้ระบุหรือไม่ทราบสถานะ
CREATING กำลังใช้ TTL มีการดำเนินการที่ใช้เวลานานเพื่อติดตามการเปลี่ยนแปลง เอกสารที่เขียนใหม่จะใช้ TTL ตามที่ขอ TTL ที่ขอในเอกสารที่มีอยู่ยังอยู่ระหว่างการประมวลผล เมื่อ TTL ในเอกสารที่มีอยู่ทั้งหมดได้รับการประมวลผล สถานะจะเปลี่ยนเป็น "ใช้งานอยู่"
ACTIVE TTL ใช้ได้กับเอกสารทั้งหมด
NEEDS_REPAIR ไม่สามารถเปิดใช้การกำหนดค่า TTL สำหรับเอกสารที่มีอยู่ทั้งหมด เอกสารที่เขียนใหม่จะยังคงใช้ TTL ต่อไป LRO แสดงผลเมื่อพยายามเปิดใช้ TTL สำหรับ Field นี้ครั้งล่าสุดไม่สำเร็จ และอาจมีรายละเอียดเพิ่มเติม

ข้อมูลเมตา FieldOperation

ผลการค้นหาข้อมูลเมตาสำหรับ 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

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

Progress

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

Progress

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

TtlConfigDelta

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

IndexConfigDelta

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

ช่อง
change_type

ChangeType

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

Index

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

ประเภทการเปลี่ยนแปลง

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

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

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

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

ช่อง
change_type

ChangeType

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

ประเภทการเปลี่ยนแปลง

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

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

รับคำขอสำรองข้อมูล

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

ช่อง
name

string

ต้องระบุ ชื่อของข้อมูลสำรองที่จะดึงข้อมูล

รูปแบบคือ projects/{project}/locations/{location}/backups/{backup}

คำขอ GetBackupSchedule

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

ช่อง
name

string

ต้องระบุ ชื่อของกำหนดการสำรองข้อมูล

ฟอร์แมต projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

GetDatabaseRequest

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

ช่อง
name

string

ต้องระบุ ชื่อของแบบฟอร์ม projects/{project_id}/databases/{database_id}

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}

นำเข้าเอกสารข้อมูลเมตา

ผลการค้นหาข้อมูลเมตาสำหรับ 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

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

string

รหัสเนมสเปซที่กำลังนำเข้า

คำขอนำเข้าเอกสาร

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

ช่อง
name

string

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

string

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

string

ตำแหน่งของไฟล์ที่ส่งออก โดยต้องตรงกับ Export_uri_prefix ของ ExportDocumentsResponse จากการส่งออกที่เสร็จสมบูรณ์แล้ว โปรดดูgoogle.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix
namespace_ids[]

string

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

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

ดัชนี

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

ช่อง
name

string

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

QueryScope

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

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

ApiScope

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

IndexField

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

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

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

State

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

ขอบเขต API

ขอบเขต API จะกำหนด API (เนทีฟในFirestore หรือ Firestore ในโหมด Datastore) ที่รองรับการค้นหา

Enum
ANY_API มีเพียง API การค้นหา Native ของ Firestore เท่านั้นที่สามารถใช้ดัชนีนี้ได้ โดยตัวเลือกนี้คือค่าเริ่มต้น
DATASTORE_MODE_API Firestore ใน API การค้นหาของโหมด Datastore จะใช้ดัชนีได้เท่านั้น

ฟิลด์ดัชนี

ช่องในดัชนี Field_path จะอธิบายช่องที่มีการจัดทำดัชนี ส่วน value_mode อธิบายวิธีจัดทําดัชนีค่าของช่อง

ช่อง
field_path

string

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

Order

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

ArrayConfig

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

VectorConfig

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

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

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

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

สั่งซื้อ

การเรียงลำดับที่รองรับ

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

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

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

ช่อง
dimension

int32

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

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

FlatIndex

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

ดัชนีคงที่

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

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

ขอบเขตการค้นหา

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

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

รัฐ

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

Enum
STATE_UNSPECIFIED ไม่ได้ระบุรัฐ
CREATING กำลังสร้างดัชนี มีการดำเนินการที่ใช้เวลานานสำหรับดัชนี ดัชนีจะมีการอัปเดตเมื่อเขียนเอกสาร อาจมีข้อมูลดัชนีบางอย่างอยู่
READY ดัชนีพร้อมใช้งานแล้ว ดัชนีจะมีการอัปเดตเมื่อเขียนเอกสาร ระบบจะป้อนข้อมูลดัชนีทั้งหมดจากเอกสารที่จัดเก็บทั้งหมดที่ใช้ดัชนีนั้น
NEEDS_REPAIR กำลังสร้างดัชนี แต่เกิดข้อผิดพลาด ไม่มีการดำเนินการที่ใช้เวลานานสำหรับดัชนี และการดำเนินการที่ใช้เวลานานซึ่งเสร็จสิ้นล่าสุดล้มเหลว ดัชนีไม่อัปเดตเมื่อเขียนเอกสาร อาจมีข้อมูลดัชนีบางอย่างอยู่ ใช้ google.longrunning.Operations 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

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

ListBackupSchedulesRequest

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

ช่อง
parent

string

ต้องระบุ ฐานข้อมูลหลัก

รูปแบบคือ projects/{project}/databases/{database}

ListBackupSchedulesResponse

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

ช่อง
backup_schedules[]

BackupSchedule

รายการกำหนดการสํารองข้อมูลทั้งหมด

ListBackupsRequest

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

ช่อง
parent

string

ต้องระบุ ตำแหน่งที่จะสร้างรายการข้อมูลสำรอง

รูปแบบคือ projects/{project}/locations/{location} ใช้ {location} = '-' เพื่อแสดงรายการข้อมูลสำรองจากทุกตำแหน่งสำหรับโปรเจ็กต์ที่ระบุ ซึ่งช่วยให้แสดงข้อมูลข้อมูลสำรองจากสถานที่เดียวหรือจากทุกตำแหน่งได้

การตอบกลับของรายการข้อมูลสำรอง

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

ช่อง
backups[]

Backup

รายการข้อมูลสำรองทั้งหมดสำหรับโปรเจ็กต์
unreachable[]

string

รายชื่อตำแหน่งที่ดึงข้อมูลข้อมูลสำรองที่มีอยู่ไม่ได้

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

แสดงรายการฐานข้อมูลคำขอ

คำขอเพื่อแสดงรายการฐานข้อมูล Firestore ในทุกตำแหน่งสำหรับโปรเจ็กต์

ช่อง
parent

string

ต้องระบุ ชื่อระดับบนสุดของแบบฟอร์ม projects/{project_id}
show_deleted

bool

หากเป็น "จริง" จะแสดงทรัพยากรที่ลบไปแล้วด้วย

การตอบสนองของ ListDatabase

รายการฐานข้อมูลสำหรับโปรเจ็กต์

ช่อง
databases[]

Database

ฐานข้อมูลในโปรเจ็กต์
unreachable[]

string

ในกรณีที่ไม่สามารถแสดงรายการข้อมูลเกี่ยวกับฐานข้อมูลแต่ละรายการ ข้อมูลเหล่านั้นจะบันทึกไว้ที่นี่

รายการตัวอย่างอาจได้แก่ projects/some_project/locations/some_location ซึ่งอาจเกิดขึ้นได้หาก Cloud Region ที่มีฐานข้อมูลนั้นอยู่ไม่พร้อมใช้งานในขณะนี้ ในกรณีนี้ เราไม่สามารถดึงรายละเอียดทั้งหมดเกี่ยวกับฐานข้อมูลได้ คุณอาจได้รับข้อความแสดงข้อผิดพลาดที่มีรายละเอียดมากขึ้น (หรืออาจดึงข้อมูลแหล่งข้อมูล) โดยการส่ง "รับ" คำขอสำหรับทรัพยากรหรือ "รายการ" ตำแหน่งที่เจาะจง

คำขอ ListFields

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

ช่อง
parent

string

ต้องระบุ ชื่อระดับบนสุดของแบบฟอร์ม projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

ตัวกรองที่จะใช้กับรายการผลลัพธ์ ขณะนี้ FirestoreAdmin.ListFields รองรับเฉพาะช่องรายชื่อที่มีการลบล้างอย่างชัดแจ้ง หากต้องการดำเนินการค้นหานี้ ให้เรียก FirestoreAdmin.ListFields พร้อมตัวกรองที่รวม indexConfig.usesAncestorConfig:false หรือ ttlConfig:*
page_size

int32

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

string

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

การตอบสนองของ ListField

การตอบกลับสำหรับ 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

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

ข้อมูลเมตาของสถานที่

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

ข้อความข้อมูลเมตาสำหรับ google.cloud.location.Location.metadata

สถานะการดำเนินการ

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

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

ความคืบหน้า

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

ช่อง
estimated_work

int64

จำนวนงานโดยประมาณ
completed_work

int64

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

กู้คืนฐานข้อมูลข้อมูลเมตา

ข้อมูลเมตาสำหรับ long-running operation จากคำขอ [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase]

ช่อง
start_time

Timestamp

เวลาที่เริ่มการกู้คืน
end_time

Timestamp

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

OperationState

สถานะการดำเนินการของการกู้คืน
database

string

ชื่อของฐานข้อมูลที่จะกู้คืน
backup

string

ชื่อของข้อมูลสำรองที่กำลังกู้คืน
progress_percentage

Progress

ระยะทางในช่วงการกู้คืนคือเปอร์เซ็นต์โดยประมาณของเวลาที่เหลืออยู่

คืนค่าฐานข้อมูลคำขอ

ข้อความคำขอสำหรับ [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase]

ช่อง
parent

string

ต้องระบุ โปรเจ็กต์ที่จะกู้คืนฐานข้อมูล รูปแบบคือ projects/{project_id}
database_id

string

ต้องระบุ รหัสที่ใช้สำหรับฐานข้อมูล ซึ่งจะกลายเป็นองค์ประกอบสุดท้ายของชื่อทรัพยากรของฐานข้อมูล รหัสฐานข้อมูลนี้ต้องไม่เชื่อมโยงกับฐานข้อมูลที่มีอยู่

ค่านี้ควรมีความยาว 4-63 อักขระ อักขระที่ใช้ได้คือ /[a-z][0-9]-/ โดยขึ้นต้นด้วยตัวอักษรและสุดท้ายเป็นตัวอักษรหรือตัวเลข ต้องไม่อยู่ในรูปแบบ UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/

"(ค่าเริ่มต้น)" รหัสฐานข้อมูลก็ถูกต้องเช่นกัน

ช่องการรวม source

source ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
backup

string

ข้อมูลสำรองที่ต้องการคืนค่า ต้องมาจากโปรเจ็กต์เดียวกันกับโปรเจ็กต์หลัก

รูปแบบคือ projects/{project_id}/locations/{location}/backups/{backup}

อัปเดตคำขอกำหนดกำหนดการสำรอง

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

ช่อง
backup_schedule

BackupSchedule

ต้องระบุ กำหนดการสำรองข้อมูลที่จะอัปเดต
update_mask

FieldMask

รายการช่องที่จะอัปเดต

อัปเดตข้อมูลเมตาฐานข้อมูล

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

ข้อมูลเมตาที่เกี่ยวข้องกับการดำเนินการอัปเดตฐานข้อมูล

อัปเดตคำขอฐานข้อมูล

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

ช่อง
database

Database

ต้องระบุ ฐานข้อมูลที่จะอัปเดต
update_mask

FieldMask

รายการช่องที่จะอัปเดต

อัปเดตฟิลด์คำขอ

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

ช่อง
field

Field

ต้องระบุ ช่องที่จะอัปเดต
update_mask

FieldMask

มาสก์ที่สัมพันธ์กับช่อง หากระบุ ระบบจะอัปเดตเฉพาะการกำหนดค่าที่ Field_mask นี้ระบุในช่องเท่านั้น

การเกิดซ้ำรายสัปดาห์

หมายถึงกำหนดการที่เกิดซ้ำซึ่งทำงานในวันที่เฉพาะเจาะจงของสัปดาห์

ใช้เขตเวลา UTC

ช่อง
day

DayOfWeek

วันของสัปดาห์ที่จะทำงาน

ไม่อนุญาตใน DAY_OF_WEEK_UNSPECIFIED