REST Resource: projects.databases.collectionGroups.fields

{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}

string

執行個體類型，表單 projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath} 的欄位名稱

欄位路徑可以是簡單的欄位名稱，例如 address，或是 mapValue 中的欄位路徑 (例如 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 符號字元來引用。

例如：(注意：此處的註解是以 Markdown 語法編寫，因此使用另一層反引號來代表程式碼區塊) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`，不是任何欄位。

特殊的 Field 包含所有欄位的預設索引設定。這個欄位的資源名稱為：這個 Field 中定義的 projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* 索引，會套用至所有沒有 Field 索引設定的欄位。

object (IndexConfig)

這個欄位的索引設定。如未設定，欄位索引功能會還原為 ancestorField 定義的設定。如要明確移除這個欄位的所有索引，請指定內含空白索引清單的索引設定。

object (TtlConfig)

這個 Field 的存留時間設定。如果您設定或取消設定，系統會針對含有這個 Field 的文件啟用或停用存留時間。

{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}

object (Index)

這個欄位支援的索引。

boolean

僅供輸出。如果設為 true，Field 的索引設定是根據 ancestorField 指定的設定進行設置。如果設為 False，系統會明確定義 Field 的索引設定。

string

僅供輸出。指定 Field 的資源名稱，該資源名稱可供設定這個欄位的索引設定 (當 usesAncestorConfig 為 true 時)；如果這個欄位沒有索引設定 (當 usesAncestorConfig 為 false 時)，則應設定這個欄位。

boolean

僅在輸出為 true 時，Field 的索引設定正在還原中。完成後，索引設定會轉換至與 ancestorField 指定欄位相同的狀態，此時 usesAncestorConfig 會是 true，reverting 會是 false。

{
  "state": enum (State)
}

enum (State)

僅供輸出。存留時間設定的狀態。