Method: projects.locations.dataAgents.patch

更新單一 DataAgent 的參數。

HTTP 要求

PATCH https://geminidataanalytics.googleapis.com/v1alpha/{dataAgent.name=projects/*/locations/*/dataAgents/*}

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

路徑參數

參數
dataAgent.name

string

(選用步驟) ID。DataAgent 的專屬資源名稱。格式：projects/{project}/locations/{location}/dataAgents/{dataAgentId} {dataAgent} 是資源 ID，長度不得超過 63 個字元，且必須符合 https://google.aip.dev/122#resource-id-segments 中說明的格式

範例：projects/1234567890/locations/us-central1/dataAgents/my-agent。

建議在建立代理程式時略過設定這個欄位，因為系統會自動推斷並以 {parent}/dataAgents/{dataAgentId} 覆寫。

查詢參數

參數
updateMask

string (FieldMask format)

(選用步驟) 欄位遮罩用於指定更新作業要在 DataAgent 資源中覆寫的欄位。updateMask 中指定的欄位與資源相關，而非完整要求。如果欄位位於遮罩中，系統會覆寫該欄位。如果使用者未提供遮罩，系統會覆寫要求中所有非預設值的欄位。如果提供萬用字元遮罩，所有欄位都會遭到覆寫。

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

string

(選用步驟) (選用) 用於識別要求的 ID。指定專屬要求 ID，這樣一來，如果必須重試要求，伺服器就會知道要忽略已完成的要求。伺服器會保證至少在第一次要求後的 60 分鐘內，

舉例來說，假設您提出初始要求，但要求逾時。如果您使用相同要求 ID 再次提出要求，伺服器會檢查是否已收到具有相同要求 ID 的原始作業，如果已收到，就會忽略第二次要求。這樣可避免客戶不慎建立重複的約定。

要求 ID 必須是有效的 UUID，但系統不支援零 UUID (00000000-0000-0000-0000-000000000000)。

要求主體

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

回應主體

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

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • geminidataanalytics.dataAgents.update

詳情請參閱 IAM 說明文件。