Method: projects.locations.collections.dataConnector.startConnectorRun

Startet einen sofortigen Synchronisierungsvorgang für ein DataConnector. Nutzer von Drittanbieter-Connectors müssen angeben, welche Einheiten synchronisiert werden sollen. FHIR-Connectors müssen einen Zeitstempel enthalten, der angibt, ab welchem Zeitpunkt Daten synchronisiert werden sollen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Connector-Name im Format projects/{project}/locations/{location}/collections/ {collectionId}/dataConnector

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "entities": [
    string
  ],
  "healthcareFhirResourceTypes": [
    string
  ],
  "forceRefreshContent": boolean,
  "syncIdentity": boolean,
  "syncSinceTimestamp": string
}
Felder
entities[]

string

Gibt an, welche Entitäten des Drittanbieter-Connectors synchronisiert werden sollen. Wenn nichts angegeben ist, werden alle Entitäten synchronisiert.

healthcareFhirResourceTypes[]

string

Die zu importierenden FHIR-Ressourcentypen. Die Ressourcentypen sollten eine Teilmenge aller unterstützten FHIR-Ressourcentypen sein. Standardmäßig werden alle unterstützten FHIR-Ressourcentypen verwendet, wenn das Feld leer ist.

forceRefreshContent

boolean

Optional. Gibt an, ob der unstrukturierte Inhalt der Dokumente aktualisiert werden soll.

Wenn diese Option auf true gesetzt ist, wird der Inhaltsteil der Dokumente unabhängig vom Aktualisierungsstatus des referenzierten Inhalts aktualisiert.

syncIdentity

boolean

Wenn „true“, wird die Identitätssynchronisierung ausgelöst.

syncSinceTimestamp

string (Timestamp format)

Zeitstempel, der den Zeitpunkt angibt, ab dem Daten für Streaming-/Batchdaten-Connectors synchronisiert werden sollen. Dieses Feld wird nur für Healthcare-Connectors verwendet.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von ConnectorRun.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • discoveryengine.dataConnectors.startConnectorRun

Weitere Informationen finden Sie in der IAM-Dokumentation.