Method: projects.locations.collections.dataConnector.startConnectorRun

立即開始同步處理 DataConnector。第三方連結器使用者必須指定要同步處理的實體。FHIR 連接器必須提供時間戳記，指出應從哪個時間點開始同步資料。

HTTP 要求

POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/dataConnector}:startConnectorRun

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

路徑參數

參數
parent

string

這是必要旗標，連接器名稱，格式為 projects/{project}/locations/{location}/collections/ {collectionId}/dataConnector

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "entities": [
    string
  ],
  "healthcareFhirResourceTypes": [
    string
  ],
  "forceRefreshContent": boolean,
  "syncIdentity": boolean,
  "syncSinceTimestamp": string
}
欄位
entities[]

string

指定要同步處理的第三方連結器實體。如未指定，系統會同步所有實體。
healthcareFhirResourceTypes[]

string

要匯入的 FHIR 資源類型。資源類型應為所有支援的 FHIR 資源類型的子集。如果留空，預設為所有支援的 FHIR 資源類型。
forceRefreshContent

boolean

(選用步驟) 是否強制重新整理文件的非結構化內容。

如果設為 true，系統會重新整理文件內容部分，無論參照內容的更新狀態為何。
syncIdentity

boolean

如果為 true，則觸發身分同步。
syncSinceTimestamp

string (Timestamp format)

時間戳記，指出串流/批次資料連接器應從哪個時間點開始同步處理資料。這個欄位僅供 Healthcare Connectors 使用。

使用 RFC 3339，產生的輸出內容一律會經過 Z 標準化，並使用 0、3、6 或 9 個小數點後位數。系統也接受「Z」以外的偏移量。例如："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

回應主體

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

授權範圍

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

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

詳情請參閱Authentication Overview。

IAM 權限

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

  • discoveryengine.dataConnectors.startConnectorRun

詳情請參閱 IAM 說明文件。