Method: projects.locations.collections.dataConnector.startConnectorRun

Inicia un proceso de sincronización inmediato para un DataConnector. Los usuarios del conector de terceros deben especificar qué entidades se deben sincronizar. Los conectores de 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 usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

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 con la siguiente estructura:

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

string

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

string

Son los tipos de recursos de FHIR que se importarán. Los tipos de recursos deben ser un subconjunto de todos los tipos de recursos de FHIR compatibles. Si está vacío, se establecerán de forma predeterminada 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 configura como true, se actualizará la parte del contenido de los documentos, independientemente del estado de actualización del contenido de referencia.
syncIdentity

boolean

Si es verdadero, se activa la sincronización de identidad.
syncSinceTimestamp

string (Timestamp format)

Es la marca de tiempo que indica el punto en el tiempo a partir del cual se deben sincronizar los datos para los conectores de datos de transmisión o por lotes. Este campo solo se utiliza para los conectores de atención médica.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “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 se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de ConnectorRun.

Alcances de autorización

Se necesita 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 Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.dataConnectors.startConnectorRun

Para obtener más información, consulta la documentación de IAM.