Method: projects.locations.collections.dataConnector.startConnectorRun

Inicia um processo de sincronização imediata para um DataConnector. Os usuários do conector de terceiros precisam especificar quais entidades devem ser sincronizadas. Os conectores FHIR precisam fornecer um carimbo de data/hora para indicar o momento em que os dados devem ser sincronizados.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

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

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

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

string

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

string

Os tipos de recursos FHIR a serem importados. Os tipos de recursos precisam ser um subconjunto de todos os tipos de recursos FHIR compatíveis. O padrão é todos os tipos de recursos FHIR compatíveis se estiver vazio.
forceRefreshContent

boolean

Opcional. Define se o conteúdo não estruturado dos documentos será atualizado à força.

Se definido como true, a parte de conteúdo dos documentos será atualizada, independente do status de atualização do conteúdo referenciado.
syncIdentity

boolean

Se for "true", acione a sincronização de identidade.
syncSinceTimestamp

string (Timestamp format)

Carimbo de data/hora para indicar o ponto no tempo a partir do qual os dados devem ser sincronizados para conectores de dados de streaming/em lote. Esse campo é usado apenas para conectores de saúde.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de ConnectorRun.

Escopos de autorização

Requer um dos seguintes escopos 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 Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • discoveryengine.dataConnectors.startConnectorRun

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