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