Method: projects.locations.collections.dataConnector.startConnectorRun

Inicia um processo de sincronização imediato para um DataConnector. Os utilizadores do conector de terceiros têm de especificar as entidades que devem ser sincronizadas. Os conetores FHIR têm de fornecer uma data/hora para indicar o momento a partir do qual os dados devem ser sincronizados.

Pedido HTTP

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

O URL usa a sintaxe de transcodificação de gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Nome do conetor no formato projects/{project}/locations/{location}/collections/ {collectionId}/dataConnector

Corpo do pedido

O corpo do pedido contém dados com a seguinte estrutura:

Representação JSON 
{
  "entities": [
    string
  ],
  "healthcareFhirResourceTypes": [
    string
  ],
  "forceRefreshContent": boolean,
  "syncIdentity": boolean,
  "syncSinceTimestamp": string
}
Campos
entities[]

string

Especifica que entidades do conector de terceiros devem ser sincronizadas. Se não for especificado, todas as entidades são sincronizadas.
healthcareFhirResourceTypes[]

string

Os tipos de recursos FHIR a importar. Os tipos de recursos devem ser um subconjunto de todos os tipos de recursos FHIR suportados. Por predefinição, todos os tipos de recursos FHIR suportados, se estiver vazio.
forceRefreshContent

boolean

Opcional. Se deve forçar a atualização do conteúdo não estruturado dos documentos.

Se estiver definido como true, a parte de conteúdo dos documentos é atualizada independentemente do estado de atualização do conteúdo de referência.
syncIdentity

boolean

Se for verdadeiro, acione a sincronização de identidades.
syncSinceTimestamp

string (Timestamp format)

Data/hora para indicar o ponto no tempo a partir do qual os dados devem ser sincronizados para os conetores de dados de streaming/em lote. Este campo só é usado para os Healthcare Connectors.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de ConnectorRun.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso parent:

  • discoveryengine.dataConnectors.startConnectorRun

Para mais informações, consulte a documentação do IAM.