ทรัพยากร: ช่อง
แสดงช่องเดียวในฐานข้อมูล
ช่องต่างๆ จะจัดกลุ่มตาม "กลุ่มคอลเล็กชัน" ซึ่งแสดงคอลเล็กชันทั้งหมดในฐานข้อมูลที่มีรหัสเดียวกัน
การแสดง JSON |
---|
{ "name": string, "indexConfig": { object ( |
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อช่องของแบบฟอร์ม เส้นทางช่องอาจเป็นชื่อช่องง่ายๆ ได้ เช่น เส้นทางช่องอาจระบุโดยใช้ ตัวอย่าง: (หมายเหตุ: ความคิดเห็นในที่นี้จะเขียนด้วยไวยากรณ์มาร์กดาวน์ จึงมีเครื่องหมายแบ็กทิกอีกชั้นเพื่อใช้แทนโค้ดบล็อก)
|
indexConfig |
การกำหนดค่าดัชนีสำหรับช่องนี้ หากไม่ได้ตั้งค่า การจัดทำดัชนีช่องจะเปลี่ยนกลับไปเป็นการกำหนดค่าที่ |
ttlConfig |
การกำหนดค่า TTL สำหรับ |
IndexConfig
การกำหนดค่าดัชนีสำหรับช่องนี้
การแสดง JSON |
---|
{
"indexes": [
{
object ( |
ช่อง | |
---|---|
indexes[] |
ดัชนีที่รองรับสำหรับช่องนี้ |
usesAncestorConfig |
เอาต์พุตเท่านั้น เมื่อเป็นจริง ระบบจะตั้งค่าการกำหนดค่าดัชนีของ |
ancestorField |
เอาต์พุตเท่านั้น ระบุชื่อทรัพยากรของ |
reverting |
แสดงผลเฉพาะเมื่อเป็น "จริง" การกำหนดค่าดัชนีของ |
TtlConfig
การกำหนดค่า TTL (time-to-live) สำหรับเอกสารที่มีการตั้งค่า Field
นี้
การจัดเก็บค่าการประทับเวลาลงในช่องที่เปิดใช้ TTL จะถือว่าเป็นเวลาหมดอายุสัมบูรณ์ของเอกสาร ค่าการประทับเวลาที่ผ่านมาบ่งบอกว่าเอกสารมีสิทธิ์หมดอายุทันที การใช้ข้อมูลประเภทอื่นๆ หรือการไม่ระบุช่องจะเป็นการปิดใช้การหมดอายุของเอกสารแต่ละรายการ
การแสดง JSON |
---|
{
"state": enum ( |
ช่อง | |
---|---|
state |
เอาต์พุตเท่านั้น สถานะของการกำหนดค่า TTL |
รัฐ
สถานะของการใช้การกำหนดค่า TTL กับเอกสารทั้งหมด
Enum | |
---|---|
STATE_UNSPECIFIED |
ไม่ได้ระบุหรือไม่ทราบสถานะ |
CREATING |
กำลังใช้ TTL มีการดำเนินการที่ใช้เวลานานเพื่อติดตามการเปลี่ยนแปลง เอกสารที่เขียนใหม่จะใช้ TTL ตามที่ขอ TTL ที่ขอในเอกสารที่มีอยู่ยังอยู่ระหว่างการประมวลผล เมื่อ TTL ในเอกสารที่มีอยู่ทั้งหมดได้รับการประมวลผล สถานะจะเปลี่ยนเป็น "ใช้งานอยู่" |
ACTIVE |
TTL ใช้ได้กับเอกสารทั้งหมด |
NEEDS_REPAIR |
ไม่สามารถเปิดใช้การกำหนดค่า TTL สำหรับเอกสารที่มีอยู่ทั้งหมด เอกสารที่เขียนใหม่จะยังคงใช้ TTL ต่อไป LRO แสดงผลเมื่อพยายามเปิดใช้ TTL สำหรับ Field นี้ครั้งล่าสุดไม่สำเร็จ และอาจมีรายละเอียดเพิ่มเติม |
เมธอด |
|
---|---|
|
รับข้อมูลเมตาและการกำหนดค่าสำหรับช่อง |
|
แสดงการกำหนดค่าช่องและข้อมูลเมตาสำหรับฐานข้อมูลนี้ |
|
อัปเดตการกำหนดค่าช่อง |