ConnectorRun

DataConnector 的数据同步运行。成功初始化 DataConnector 后,系统会在 DataConnector.refresh_interval 安排数据同步。ConnectorRun 表示过去或当前正在进行的数据同步。//

JSON 表示法
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "state": enum (State),
  "errors": [
    {
      object (Status)
    }
  ],
  "stateUpdateTime": string,
  "latestPauseTime": string,
  "entityRuns": [
    {
      object (EntityRun)
    }
  ],
  "trigger": enum (Trigger)
}
字段
name

string

仅限输出。连接器运行的完整资源名称。格式:projects/*/locations/*/collections/*/dataConnector/connectorRuns/*connectorRunId 由系统生成。

startTime

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"

endTime

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"

state

enum (State)

仅限输出。同步运行的状态。

errors[]

object (Status)

包含同步期间发生的错误的相关信息。仅在遇到错误状态时存在。包含错误代码和错误消息。与 state 字段搭配使用。

stateUpdateTime

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"

latestPauseTime

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"

entityRuns[]

object (EntityRun)

仅限输出。在 ConnectorRun 中同步的实体的详细信息。每个 ConnectorRun 都包含一个或多个实体的同步。

trigger

enum (Trigger)

仅限输出。相应 ConnectorRun 的触发器。

运行状态。

枚举
STATE_UNSPECIFIED 默认值。
RUNNING 数据同步正在进行中。
SUCCEEDED 数据同步已完成。
FAILED 数据同步失败。
OVERRUN 数据同步运行时长超出预期,并且持续到下次同步应该开始时仍未完成。
CANCELLED 之前预定了数据同步,但已取消。
PENDING 数据同步即将开始。
WARNING 数据同步已完成,但有非严重错误。
SKIPPED 正在进行的连接器运行已超出预期运行时间,导致此运行被跳过。

EntityRun

表示在相应 ConnectorRun 中同步的实体。

JSON 表示法
{
  "entityName": string,
  "state": enum (State),
  "errors": [
    {
      object (Status)
    }
  ],
  "stateUpdateTime": string,
  "progress": {
    object (Progress)
  },
  "statsUpdateTime": string,
  "syncType": enum (SyncType),
  "scheduledRecordCount": string,
  "extractedRecordCount": string,
  "indexedRecordCount": string,
  "errorRecordCount": string,
  "sourceApiRequestCount": string,
  "deletedRecordCount": string
}
字段
entityName

string

源实体的名称。

state

enum (State)

实体的同步运行状态。

errors[]

object (Status)

实体同步运行中的错误。仅在遇到错误状态时存在。包含错误代码和错误消息。

stateUpdateTime

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"

progress

object (Progress)

元数据来生成进度条。

statsUpdateTime

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"

syncType

enum (SyncType)

相应运行的同步类型。

scheduledRecordCount

string (int64 format)

可选。计划从连接器来源抓取/提取的文档数量。这仅适用于第三方连接器。

extractedRecordCount

string (int64 format)

可选。从连接器来源提取的文档数,准备提取到 VAIS。

indexedRecordCount

string (int64 format)

可选。已编入索引的文档数量。

errorRecordCount

string (int64 format)

可选。在编制索引阶段同步失败的文档总数。

sourceApiRequestCount

string (int64 format)

可选。发送到第三方 API 的请求数量。

deletedRecordCount

string (int64 format)

可选。已删除的文档数量。

进度

表示同步运行的进度。

JSON 表示法
{
  "currentCount": string,
  "totalCount": string,
  "percentile": number
}
字段
currentCount

string (int64 format)

当前进度。

totalCount

string (int64 format)

总计。

percentile

number

派生。进度(即 progress.current_count / totalCount)的百分位数。该值介于 [0, 1.0] 之间(含 0 和 1.0)。

SyncType

连接器的数据同步类型。

枚举
SYNC_TYPE_UNSPECIFIED 未指定同步类型。
FULL 同步会触发所有文档的完全同步。
INCREMENTAL 更新文档的增量同步。
REALTIME 实时同步。
SCALA_SYNC Scala 同步。

触发器

触发 ConnectorRun 的原因。

枚举
TRIGGER_UNSPECIFIED 默认值。
SCHEDULER 如果连接器具有 PERIODIC 同步模式,则由调度程序触发的 ConnectorRun。
INITIALIZATION 由连接器初始化自动触发的 ConnectorRun。
RESUME ConnectorRun 由恢复连接器自动触发。
MANUAL 由用户手动触发的 ConnectorRun。