Method: projects.locations.collections.engines.patch

更新 Engine

HTTP 要求

PATCH https://discoveryengine.googleapis.com/v1alpha/{engine.name=projects/*/locations/*/collections/*/engines/*}

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
engine.name

string

不可變動。ID。引擎的完整資源名稱。

這個欄位必須是 UTF-8 編碼的字串，長度上限為 1024 個字元。

格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine} 引擎長度應為 1 至 63 個字元，有效字元為 /[a-z0-9][a-z0-9-_]*/。否則，系統會傳回 INVALID_ARGUMENT 錯誤。

查詢參數

參數
updateMask

string (FieldMask format)

指出要更新所提供 Engine 的哪些欄位。

如果您提供的是不明或不支援的欄位，則會傳回 INVALID_ARGUMENT 錯誤。

這是以半形逗號分隔的完整欄位名稱清單。範例："user.displayName,photo"。

要求主體

要求主體包含 Engine 的執行個體。

回應主體

如果成功，回應主體會包含 Engine 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳情請參閱Authentication Overview。

IAM 權限

需要 name 資源的下列 IAM 權限：

  • discoveryengine.engines.update

詳情請參閱 IAM 說明文件。