資源:欄位
代表資料庫中的單一欄位。
欄位是按「集合群組」分類,代表資料庫中具備相同 ID 的所有集合。
JSON 表示法 |
---|
{ "name": string, "indexConfig": { object ( |
欄位 | |
---|---|
name |
必要欄位。 欄位路徑可以是簡單的欄位名稱,例如 欄位路徑可以使用 範例:(注意:這裡的註解是以 Markdown 語法撰寫,因此還有一個倒引號來代表程式碼區塊) 特殊的 |
indexConfig |
這個欄位的索引設定。如未設定,欄位索引功能會還原為 |
ttlConfig |
這個「 |
IndexConfig
這個欄位的索引設定。
JSON 表示法 |
---|
{
"indexes": [
{
object ( |
欄位 | |
---|---|
indexes[] |
這個欄位支援的索引。 |
usesAncestorConfig |
僅供輸出。如果為 true, |
ancestorField |
僅供輸出。指定已設定這個欄位索引設定時所用 |
reverting |
僅輸出為 true 時, |
TtlConfig
已設定此 Field
的文件的存留時間 (TTL) 設定。
系統會將時間戳記值儲存到啟用存留時間的欄位,並視為文件的絕對到期時間。過去的時間戳記值代表文件可以立即到期。使用任何其他資料類型或將欄位留空,系統就會停用個別文件的到期時間。
JSON 表示法 |
---|
{
"state": enum ( |
欄位 | |
---|---|
state |
僅供輸出。存留時間設定的狀態。 |
狀態
要將存留時間設定套用至所有文件的狀態。
列舉 | |
---|---|
STATE_UNSPECIFIED |
狀態不明或不明。 |
CREATING |
正在套用存留時間。目前有一個長時間執行的作業來追蹤變更。新撰寫的文件會依照要求套用存留時間。系統仍在處理現有文件要求的存留時間。所有現有文件的存留時間處理完畢後,狀態會變更為「有效」。 |
ACTIVE |
所有文件的存留時間皆已啟用。 |
NEEDS_REPAIR |
無法為所有現有文件啟用存留時間設定。新撰寫的文件仍會套用存留時間 (TTL)。上次嘗試啟用這個「Field 」的 TTL 時傳回的 LRO 作業失敗,可能擁有更多詳細資料。 |
方法 |
|
---|---|
|
取得欄位的中繼資料和設定。 |
|
列出這個資料庫的欄位設定和中繼資料。 |
|
更新欄位設定。 |