为一个 DataConnector 启动即时同步过程。第三方连接器用户必须指定应同步哪些实体。FHIR 连接器必须提供一个时间戳,以指示应从哪个时间点开始同步数据。
HTTP 请求
POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/dataConnector}:startConnectorRun
网址采用 gRPC 转码语法。
路径参数
| 参数 | |
|---|---|
parent |
必需。连接器的名称,格式为 projects/{project}/locations/{location}/collections/ {collectionId}/dataConnector |
请求正文
请求正文中包含结构如下的数据:
| JSON 表示法 |
|---|
{ "entities": [ string ], "healthcareFhirResourceTypes": [ string ], "forceRefreshContent": boolean, "syncIdentity": boolean, "syncSinceTimestamp": string } |
| 字段 | |
|---|---|
entities[] |
指定应同步哪些第三方连接器实体。如果未指定,则将同步所有实体。 |
healthcareFhirResourceTypes[] |
要导入的 FHIR 资源类型。资源类型应是所有受支持的 FHIR 资源类型的一个子集。如果为空,则默认为所有受支持的 FHIR 资源类型。 |
forceRefreshContent |
可选。指示是否强制刷新文档的非结构化内容。 如果设置为 |
syncIdentity |
如果为 true,则会触发身份同步。 |
syncSinceTimestamp |
一个时间戳,用于指示流式/批量数据连接器应从哪个时间点开始同步数据。此字段仅用于医疗保健连接器。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
响应正文
如果成功,则响应正文包含一个 ConnectorRun 实例。
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/discoveryengine.readwritehttps://www.googleapis.com/auth/discoveryengine.assist.readwrite
如需了解详情,请参阅 Authentication Overview。
IAM 权限
需要拥有 parent 资源的以下 IAM 权限:
discoveryengine.dataConnectors.startConnectorRun
如需了解详情,请参阅 IAM 文档。