更新欄位設定。目前欄位更新僅適用於單一欄位索引設定。不過,對 FirestoreAdmin.UpdateField
的呼叫應提供欄位遮罩,以免變更呼叫端不知道的設定。欄位遮罩應指定為:{ paths: "indexConfig" }
。
這個呼叫會傳回 google.longrunning.Operation
,可用於追蹤欄位更新的狀態。作業的中繼資料將為 FieldOperationMetadata
類型。
若要設定資料庫的預設欄位設定,請使用特殊的 Field
,以及資源名稱:projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*
。
HTTP 要求
PATCH https://firestore.googleapis.com/v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
field.name |
欄位路徑可以是簡單的欄位名稱,例如 欄位路徑可以使用 範例:(注意:這裡的註解是以 Markdown 語法撰寫,因此還有一個倒引號來代表程式碼區塊) 特殊的 |
查詢參數
參數 | |
---|---|
updateMask |
相對於欄位的遮罩。如有指定,系統只會更新 欄位中的 field_mask 指定的設定。 此為以半形逗號分隔的完整欄位名稱清單,範例: |
要求主體
要求主體包含 Field
的例項。
回應主體
如果成功,回應主體會包含 Operation
的執行例項。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
詳情請參閱驗證總覽。