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

出力専用。Connector Run の完全なリソース名。形式: projects/*/locations/*/collections/*/dataConnector/connectorRuns/*。connectorRunId はシステムによって生成されます。
startTime

string (Timestamp format)

出力専用。コネクタの実行が開始された時刻。

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"。
endTime

string (Timestamp format)

出力専用。コネクタの実行が終了した時刻。

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"。
state

enum (State)

出力専用。同期実行の状態。
errors[]

object (Status)

同期中に発生したエラーに関する情報が含まれます。エラー状態になった場合にのみ存在します。エラーコードとエラー メッセージが含まれます。state フィールドとともに使用します。
stateUpdateTime

string (Timestamp format)

コネクタ実行の同期状態が最後に更新されたときのタイムスタンプ。

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"。
latestPauseTime

string (Timestamp format)

出力専用。コネクタの実行が最後に一時停止された時刻。

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"。
entityRuns[]

object (EntityRun)

出力専用。ConnectorRun で同期されたエンティティの詳細。各 ConnectorRun は、1 つ以上のエンティティの同期で構成されます。
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 正規化され、小数点以下は 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)

extracted_documents_count、indexed_documents_count、error_documents_count のいずれかのタイムスタンプが最後に更新された日時。

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"。
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] の範囲です。

SyncType

コネクタのデータ同期タイプ。

列挙型
SYNC_TYPE_UNSPECIFIED 同期タイプが指定されていません。
FULL 同期により、すべてのドキュメントの完全同期がトリガーされます。
INCREMENTAL 更新されたドキュメントの増分同期。
REALTIME リアルタイム同期。
SCALA_SYNC Scala の同期。

トリガー

ConnectorRun のトリガー理由。

列挙型
TRIGGER_UNSPECIFIED デフォルト値。
SCHEDULER コネクタに PERIODIC 同期モードがある場合、スケジューラによってトリガーされる ConnectorRun。
INITIALIZATION コネクタの初期化によって自動的にトリガーされる ConnectorRun。
RESUME コネクタの再開によって自動的にトリガーされた ConnectorRun。
MANUAL ユーザーが手動でトリガーした ConnectorRun。