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)

时间戳，用于指示应从哪个时间点开始同步流式/批量数据连接器的数据。此字段仅用于医疗保健连接器。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 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 文档。