更新字段配置。目前,欄位更新僅適用於單一欄位索引配置。但是,對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/*}
URL 使用gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
field.name | 表單的欄位名稱 欄位路徑可以是簡單的欄位名稱,例如 欄位路徑可以使用 範例:(注意:這裡的註解是用 markdown 語法寫的,所以多了一層反引號來表示程式碼區塊) 特殊 |
查詢參數
參數 | |
---|---|
updateMask | 掩模,相對於場。如果指定,則只有此 field_mask 指定的配置才會在欄位中更新。 這是一個以逗號分隔的欄位完全限定名稱清單。範例: |
請求正文
請求正文包含Field
的實例。
響應體
如果成功,回應正文將包含一個Operation
實例。
授權範圍
需要以下 OAuth 範圍之一:
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
有關詳細信息,請參閱身份驗證概述。