ConnectorRun

JSON representation
State
EntityRun
- JSON representation
SyncType
Trigger

A data sync run of DataConnector. After DataConnector is successfully initialized, data syncs are scheduled at DataConnector.refresh_interval. A ConnectorRun represents a data sync either in the past or onging that the moment. //

JSON representation

JSON representation
{ "name": string, "startTime": string, "endTime": string, "state": enum (`State`), "errors": [ { object (`Status`) } ], "stateUpdateTime": string, "latestPauseTime": string, "entityRuns": [ { object (`EntityRun`) } ], "trigger": enum (`Trigger`) }

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

Fields
`name`	`string` Output only. The full resource name of the Connector Run. Format: `projects//locations//collections//dataConnector/connectorRuns/`. The `connector_run_id` is system-generated.
`startTime`	`string (Timestamp format)` Output only. The time when the connector run started. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`endTime`	`string (Timestamp format)` Output only. The time when the connector run ended. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`state`	`enum (State)` Output only. The state of the sync run.
`errors[]`	`object (Status)` Contains info about errors incurred during the sync. Only exist if running into an error state. Contains error code and error message. Use with the `state` field.
`stateUpdateTime`	`string (Timestamp format)` timestamp at which the connector run sync state was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`latestPauseTime`	`string (Timestamp format)` Output only. The time when the connector run was most recently paused. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`entityRuns[]`	`object (EntityRun)` Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities.
`trigger`	`enum (Trigger)` Output only. The trigger for this `ConnectorRun`.

State

The state of run.

Enums
`STATE_UNSPECIFIED`	Default value.
`RUNNING`	The data sync is ongoing.
`SUCCEEDED`	The data sync is finished.
`FAILED`	The data sync is failed.
`OVERRUN`	data sync has been running longer than expected and is still running at the time the next run is supposed to start.
`CANCELLED`	data sync was scheduled but has been cancelled.
`PENDING`	data sync is about to start.
`WARNING`	The data sync completed with non-fatal errors.

EntityRun

Represents an entity that was synced in this ConnectorRun.

JSON representation

JSON representation
{ "entityName": string, "state": enum (`State`), "errors": [ { object (`Status`) } ], "stateUpdateTime": string, "extractedRecordCount": string, "indexedRecordCount": string, "errorRecordCount": string, "sourceApiRequestCount": string, "statsUpdateTime": string, "syncType": enum (`SyncType`) }

{
  "entityName": string,
  "state": enum (State),
  "errors": [
    {
      object (Status)
    }
  ],
  "stateUpdateTime": string,
  "extractedRecordCount": string,
  "indexedRecordCount": string,
  "errorRecordCount": string,
  "sourceApiRequestCount": string,
  "statsUpdateTime": string,
  "syncType": enum (SyncType)
}

Fields
`entityName`	`string` The name of the source entity.
`state`	`enum (State)` The state of the entity's sync run.
`errors[]`	`object (Status)` The errors from the entity's sync run. Only exist if running into an error state. Contains error code and error message.
`stateUpdateTime`	`string (Timestamp format)` timestamp at which the entity sync state was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`extractedRecordCount`	`string (int64 format)` The number of documents extracted from connector source, ready to be ingested to UCS.
`indexedRecordCount`	`string (int64 format)` The number of documents indexed.
`errorRecordCount`	`string (int64 format)` The total number of documents failed at sync at any stage (extraction, indexing, etc).
`sourceApiRequestCount`	`string (int64 format)` The number of requests sent to 3p API.
`statsUpdateTime`	`string (Timestamp format)` The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`syncType`	`enum (SyncType)` Sync type of this run.

SyncType

data synchronization type of the connector.

Enums
`SYNC_TYPE_UNSPECIFIED`	Sync type unspecified.
`FULL`	Sync triggers full sync of all documents.
`INCREMENTAL`	Incremental sync of updated documents.

Trigger

Triggering reasons for ConnectorRun.

Enums
`TRIGGER_UNSPECIFIED`	Default value.
`SCHEDULER`	ConnectorRun triggered by scheduler if connector has PERIODIC sync mode.
`INITIALIZATION`	ConnectorRun auto triggered by connector initialization.
`RESUME`	ConnectorRun auto triggered by resuming connector.
`MANUAL`	ConnectorRun triggered by user manually.