Method: projects.locations.collections.dataConnector.startConnectorRun

Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Connector name of the form projects/{project}/locations/{location}/collections/ {collectionId}/dataConnector

Request body

The request body contains data with the following structure:

JSON representation 
{
  "entities": [
    string
  ],
  "healthcareFhirResourceTypes": [
    string
  ],
  "syncIdentity": boolean,
  "syncSinceTimestamp": string
}
Fields
entities[]

string

Specifies which Third Party Connector entities should be synced. If not specified, all entities will be synced.
healthcareFhirResourceTypes[]

string

The FHIR resource types to import. The resource types should be a subset of all supported FHIR resource types. Default to all supported FHIR resource types if empty.
syncIdentity

boolean

If true, trigger Identity sync.
syncSinceTimestamp

string (Timestamp format)

timestamp to indicate the point in time from which data should be synced for Streaming/Batch data Connectors. This field is only utilized for Healthcare Connectors.

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

Response body

If successful, the response body contains an instance of ConnectorRun.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.