Method: projects.locations.collections.dataConnector.startConnectorRun

DataConnector の即時同期プロセスを開始します。サードパーティ コネクタのユーザーは、同期するエンティティを指定する必要があります。FHIR コネクタは、データを同期する時点を示すタイムスタンプを提供する必要があります。

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/dataConnector}:startConnectorRun

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 の場合、ID の同期をトリガーします。
syncSinceTimestamp

string (Timestamp format)

ストリーミング/バッチ データ コネクタのデータの同期を開始する時点を示すタイムスタンプ。このフィールドは Healthcare Connector でのみ使用されます。

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

レスポンスの本文

成功した場合、レスポンスの本文には 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 のドキュメントをご覧ください。