Method: projects.locations.collections.dataConnector.startConnectorRun

Inicia un proceso de sincronización inmediato para un DataConnector. Los usuarios de conectores de terceros deben especificar qué entidades se deben sincronizar. Los conectores FHIR deben proporcionar una marca de tiempo para indicar el momento a partir del cual se deben sincronizar los datos.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Nombre del conector con el formato projects/{project}/locations/{location}/collections/ {collectionId}/dataConnector

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan la siguiente estructura:

Representación JSON 
{
  "entities": [
    string
  ],
  "healthcareFhirResourceTypes": [
    string
  ],
  "forceRefreshContent": boolean,
  "syncIdentity": boolean,
  "syncSinceTimestamp": string
}
Campos
entities[]

string

Especifica qué entidades de conector de terceros se deben sincronizar. Si no se especifica, se sincronizarán todas las entidades.
healthcareFhirResourceTypes[]

string

Los tipos de recursos FHIR que se van a importar. Los tipos de recursos deben ser un subconjunto de todos los tipos de recursos FHIR admitidos. Si está vacío, se usarán todos los tipos de recursos FHIR admitidos.
forceRefreshContent

boolean

Opcional. Indica si se debe forzar la actualización del contenido no estructurado de los documentos.

Si se asigna el valor true, la parte del contenido de los documentos se actualizará independientemente del estado de actualización del contenido de referencia.
syncIdentity

boolean

Si es true, activa la sincronización de identidades.
syncSinceTimestamp

string (Timestamp format)

Marca de tiempo que indica el momento a partir del cual se deben sincronizar los datos de los conectores de datos de streaming o por lotes. Este campo solo se utiliza en los conectores de asistencia sanitaria.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Cuerpo de la respuesta

Si la solicitud se hace correctamente, en el cuerpo de la respuesta se incluye una instancia de ConnectorRun.

Permisos de autorización

Debes disponer de uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso parent:

  • discoveryengine.dataConnectors.startConnectorRun

Para obtener más información, consulta la documentación de gestión de identidades y accesos.