DataConnector

Gerencia a conexão com fontes de dados externas para todos os repositórios de dados agrupados em um Collection. É um recurso singleton de Collection. A inicialização só é compatível com o método DataConnectorService.SetUpDataConnector, que cria um novo Collection e inicializa o DataConnector dele.

Representação JSON 
{
  "name": string,
  "state": enum (State),
  "dataSource": string,
  "removeParamKeys": [
    string
  ],
  "refreshInterval": string,
  "nextSyncTime": {
    object (DateTime)
  },
  "entities": [
    {
      object (SourceEntity)
    }
  ],
  "createTime": string,
  "latestPauseTime": string,
  "lastSyncTime": string,
  "updateTime": string,
  "errors": [
    {
      object (Status)
    }
  ],
  "syncMode": enum (SyncMode),
  "kmsKeyName": string,
  "destinationConfigs": [
    {
      object (DestinationConfig)
    }
  ],
  "actionState": enum (State),
  "actionConfig": {
    object (ActionConfig)
  },
  "endUserConfig": {
    object (EndUserConfig)
  },
  "federatedConfig": {
    object (FederatedConfig)
  },
  "connectorModes": [
    enum (ConnectorMode)
  ],
  "staticIpEnabled": boolean,
  "staticIpAddresses": [
    string
  ],
  "blockingReasons": [
    enum (BlockingReason)
  ],
  "identityRefreshInterval": string,
  "identityScheduleConfig": {
    object (IdentityScheduleConfig)
  },
  "privateConnectivityProjectId": string,
  "bapConfig": {
    object (BAPConfig)
  },
  "connectorType": enum (ConnectorType),
  "realtimeState": enum (State),
  "alertPolicyConfigs": [
    {
      object (AlertPolicyConfig)
    }
  ],
  "realtimeSyncConfig": {
    object (RealtimeSyncConfig)
  },
  "aclEnabled": boolean,
  "createEuaSaas": boolean,
  "autoRunDisabled": boolean,
  "incrementalSyncDisabled": boolean,
  "incrementalRefreshInterval": string,
  "hybridIngestionDisabled": boolean,

  // Union field data_connector_params can be only one of the following:
  "params": {
    object
  },
  "jsonParams": string
  // End of list of possible types for union field data_connector_params.
}
Campos
name

string

Apenas saída. O nome completo do recurso do conector de dados. Formato: projects/*/locations/*/collections/*/dataConnector.
state

enum (State)

Apenas saída. Estado do conector.
dataSource

string

Obrigatório. O nome da fonte de dados. Valores aceitos: salesforce, jira, confluence, bigquery.
removeParamKeys[]

string

Opcional. Especifica as chaves a serem removidas do campo "params". Isso só fica ativo quando "params" está incluído no "updateMask" em um UpdateDataConnectorRequest. A exclusão tem precedência se uma chave estiver em "removeParamKeys" e presente no campo "params" da solicitação.
refreshInterval

string (Duration format)

Obrigatório. O intervalo de atualização para a sincronização de dados. Se a duração for definida como 0, os dados serão sincronizados em tempo real. O recurso de streaming ainda não está disponível. O mínimo é de 30 minutos e o máximo é de 7 dias. Quando o intervalo de atualização é definido com o mesmo valor do intervalo de atualização incremental, a sincronização incremental é desativada.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
nextSyncTime

object (DateTime)

Define o horário programado para a próxima sincronização de dados. Esse campo exige hora, minuto e fuso horário do banco de dados de fuso horário da IANA. Isso é usado quando o conector de dados tem um intervalo de atualização maior que um dia. Quando as horas ou os minutos não são especificados, presumimos um horário de sincronização de 0:00. O usuário precisa informar um fuso horário para evitar ambiguidade.
entities[]

object (SourceEntity)

Lista de entidades da fonte de dados conectada a serem ingeridas.
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora em que o DataConnector foi criado.

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

string (Timestamp format)

Apenas saída. O carimbo de data/hora mais recente em que este DataConnector foi pausado, afetando todas as funcionalidades, como a sincronização de dados. Pausar um conector tem os seguintes efeitos: - Todas as funcionalidades, incluindo a sincronização de dados, são interrompidas. - Todos os jobs de sincronização de dados em andamento serão cancelados. - Nenhuma sincronização de dados futura será programada ou poderá ser acionada.

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

string (Timestamp format)

Apenas saída. Somente para conectores periódicos, a última vez que uma sincronização de dados foi concluída.

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

string (Timestamp format)

Apenas saída. Carimbo de data/hora da última atualização do DataConnector.

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".
errors[]

object (Status)

Apenas saída. Os erros da inicialização ou da execução mais recente do conector.
syncMode

enum (SyncMode)

O modo de sincronização de dados compatível com o conector de dados.
kmsKeyName

string

Somente entrada. A chave do KMS a ser usada para proteger os DataStores gerenciados por este conector.

Precisa ser definido para solicitações que precisam obedecer às proteções da política da organização da CMEK.

Se esse campo for definido e processado com sucesso, os DataStores criados por esse conector serão protegidos pela chave do KMS.
destinationConfigs[]

object (DestinationConfig)

Opcional. Qualquer destino usado para se conectar a serviços de terceiros.
actionState

enum (State)

Somente saída. Estado do conector de ação. Isso reflete se o conector de ação está sendo inicializado, ativo ou encontrou erros.
actionConfig

object (ActionConfig)

Opcional. Configurações de ação para que o conector ofereça suporte a ações.
endUserConfig

object (EndUserConfig)

Opcional. Parâmetros e credenciais usados especificamente para conectores da UEA.
federatedConfig

object (FederatedConfig)

Opcional. Todos os parâmetros e credenciais usados especificamente para conectores híbridos que oferecem suporte ao modo FEDERATED. Esse campo só deve ser definido se o conector for híbrido e quisermos ativar o modo FEDERATED.
connectorModes[]

enum (ConnectorMode)

Opcional. Os modos ativados para este conector. O estado padrão é CONNECTOR_MODE_UNSPECIFIED.
staticIpEnabled

boolean

Opcional. Indica se o cliente ativou endereços IP estáticos para este conector.
staticIpAddresses[]

string

Apenas saída. Os endereços IP estáticos usados por esse conector.
blockingReasons[]

enum (BlockingReason)

Apenas saída. Ações do usuário que precisam ser concluídas antes que o conector possa começar a sincronizar dados.
identityRefreshInterval
(deprecated)

string (Duration format)

O intervalo de atualização para sincronizar as informações da lista de controle de acesso dos documentos ingeridos por esse conector. Se não for definida, a lista de controle de acesso será atualizada no intervalo padrão de 30 minutos. O intervalo de atualização da identidade pode ser de no mínimo 30 minutos e no máximo 7 dias.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
identityScheduleConfig

object (IdentityScheduleConfig)

A configuração das execuções de sincronização de dados de identidade. Contém o intervalo de atualização para sincronizar as informações da lista de controle de acesso dos documentos ingeridos por esse conector.
privateConnectivityProjectId

string

Apenas saída. O ID do projeto do locatário associado aos conectores de conectividade particular. Esse projeto precisa estar na lista de permissões para que o conector funcione.
bapConfig

object (BAPConfig)

Opcional. A configuração para estabelecer uma conexão BAP.
connectorType

enum (ConnectorType)

Apenas saída. O tipo de conector. Cada origem só pode ser mapeada para um tipo. Por exemplo, o Salesforce, o Confluence e o Jira têm o tipo de conector THIRD_PARTY. Ele não pode ser mudado depois de definido pelo sistema.
realtimeState

enum (State)

Apenas saída. Estado da sincronização em tempo real
alertPolicyConfigs[]

object (AlertPolicyConfig)

Opcional. A configuração de alerta no nível do conector.
realtimeSyncConfig

object (RealtimeSyncConfig)

Opcional. A configuração para sincronização em tempo real.
aclEnabled

boolean

Opcional. Se o conector será criado com uma configuração de ACL. No momento, esse campo só afeta os conectores do Cloud Storage e do BigQuery.
createEuaSaas

boolean

Opcional. Se o conector END USER AUTHENTICATION foi criado no SaaS.
autoRunDisabled

boolean

Opcional. Indica se o conector está desativado para execução automática. Ele pode ser usado para pausar a sincronização periódica e em tempo real. Atualização: com a introdução de incrementalSyncDisabled, autoRunDisabled é usado para pausar/desativar apenas sincronizações completas.
incrementalSyncDisabled

boolean

Opcional. Indica se as sincronizações incrementais estão pausadas para esse conector. Isso é independente de "autoRunDisabled". Aplicável apenas a conectores de terceiros. Quando o intervalo de atualização é definido com o mesmo valor do intervalo de atualização incremental, a sincronização incremental é desativada, ou seja, definida como "true".
incrementalRefreshInterval

string (Duration format)

Opcional. O intervalo de atualização específico para sincronizações de dados incrementais. Se não for definido, as sincronizações incrementais usarão o padrão do ambiente, definido como 3 horas. O mínimo é de 30 minutos e o máximo é de 7 dias. Aplicável apenas a conectores de terceiros. Quando o intervalo de atualização é definido com o mesmo valor do intervalo de atualização incremental, a sincronização incremental é desativada.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
hybridIngestionDisabled

boolean

Opcional. Se o conector for híbrido, determina se a ingestão está ativada e se os recursos adequados são provisionados durante a criação do conector. Se o conector não for híbrido, esse campo será ignorado.

Campo de união data_connector_params. Parâmetros necessários para acessar a origem no formato de pares (chave, valor). Os valores de string com o formato projects/*/[locations/*/]secrets/*/versions/* serão lidos do Secret Manager.

Parâmetros obrigatórios para todas as fontes de dados:

  • Chave: instance_uri
  • Valor: tipo STRING. O URI para acessar a fonte de dados.

Parâmetros obrigatórios para fontes que aceitam OAUTH, ou seja, salesforce:

  • Chave: client_id
  • Valor: tipo STRING. O ID do cliente do provedor de serviços terceirizado para identificar seu aplicativo.
  • Chave: client_secret
  • Valor:tipo STRING. A chave secreta do cliente gerada pelo servidor de autorização de terceiros.
  • Chave: access_token
  • Valor: tipo STRING. Token OAuth para o UCS acessar o recurso protegido.
  • Chave: refresh_token
  • Valor: tipo STRING. Token de atualização do OAuth para que o UCS receba um novo token de acesso sem interação do usuário.

Parâmetros obrigatórios para fontes que aceitam autenticação básica de token de API, ou seja, jira e confluence:

  • Chave: user_account
  • Valor: tipo STRING. O nome de usuário ou e-mail com a fonte.
  • Chave: api_token
  • Valor: tipo STRING. O token de API gerado para a conta de origem, usado para autenticação em qualquer lugar em que você usaria uma senha.

Exemplo:

{
                                "instance_uri": "https://xxx.atlassian.net",
                                "user_account": "xxxx.xxx@xxx.com",
                                "api_token": "test-token"
                              }

Parâmetro opcional para especificar o tipo de autorização a ser usado para suporte a vários tipos de autorização:

  • Chave: auth_type
  • Valor: tipo STRING. O tipo de autorização da fonte de dados. Valores aceitos: BASIC_AUTH, OAUTH, OAUTH_ACCESS_TOKEN, OAUTH_TWO_LEGGED, OAUTH_JWT_BEARER, OAUTH_PASSWORD_GRANT, JWT, API_TOKEN, FEDERATED_CREDENTIAL. data_connector_params pode ser apenas um dos seguintes:
params

object (Struct format)

Parâmetros obrigatórios do conector de dados no formato JSON estruturado.
jsonParams

string

Parâmetros obrigatórios do conector de dados no formato de string JSON.

Estado

O estado do conector.

Tipos enumerados
STATE_UNSPECIFIED Valor padrão.
CREATING O conector está sendo configurado.
ACTIVE O conector foi configurado e está aguardando a próxima execução de sincronização.
FAILED O conector está com erro. Os detalhes do erro podem ser encontrados em DataConnector.errors. Se o erro não puder ser corrigido, o DataConnector poderá ser excluído pela API [CollectionService.DeleteCollection].
RUNNING O conector está sincronizando ativamente os registros da fonte de dados.
WARNING O conector concluiu uma execução de sincronização, mas encontrou erros não fatais.
INITIALIZATION_FAILED Falha na inicialização do conector. As possíveis causas incluem erros de tempo de execução ou problemas no pipeline assíncrono, impedindo que a solicitação chegue aos serviços downstream (exceto alguns tipos de conector).
UPDATING O conector está em processo de atualização.

SourceEntity

Representa uma entidade na fonte de dados. Por exemplo, o objeto Account no Salesforce.

Representação JSON 
{
  "entityName": string,
  "keyPropertyMappings": {
    string: string,
    ...
  },
  "dataStore": string,
  "startingSchema": {
    object (Schema)
  },
  "healthcareFhirConfig": {
    object (HealthcareFhirConfig)
  },

  // Union field entity_params can be only one of the following:
  "params": {
    object
  },
  "jsonParams": string
  // End of list of possible types for union field entity_params.
}
Campos
entityName

string

É o nome da entidade. Valores compatíveis por fonte de dados:

  • Salesforce: Lead, Opportunity, Contact, Account, Case, Contract, Campaign
  • Jira: Issue
  • Confluence: Content, Space
keyPropertyMappings

map (key: string, value: string)

Atributos para indexação. Chave: nome do campo. Valor: a propriedade de chave para mapear um campo, como title e description. Propriedades de chave compatíveis:

  • title: o título do registro de dados. Isso seria exibido nos resultados da pesquisa.
  • description: a descrição do registro de dados. Isso seria exibido nos resultados da pesquisa.
dataStore

string

Apenas saída. O nome completo do recurso do repositório de dados associado à entidade de origem. Formato: projects/*/locations/*/collections/*/dataStores/*. Quando o conector é inicializado pelo método DataConnectorService.SetUpDataConnector, um DataStore é criado automaticamente para cada entidade de origem.
startingSchema

object (Schema)

Opcional. O esquema inicial a ser usado para o DataStore criado com base neste SourceEntity. Se não for definido, um esquema vertical especializado padrão será usado.

Esse campo é usado apenas pela API [SetUpDataConnector][] e será ignorado se usado em outras APIs. Esse campo será omitido de todas as respostas da API, incluindo a API [GetDataConnector][]. Para recuperar um esquema de um DataStore, use a API SchemaService.GetSchema.

O esquema fornecido será validado de acordo com determinadas regras. Saiba mais neste documento.
healthcareFhirConfig

object (HealthcareFhirConfig)

Opcional. Configuração para a categoria HEALTHCARE_FHIR.

Campo de união entity_params. Os parâmetros da entidade para facilitar a ingestão de dados. Por exemplo, para conectores do BigQuery:

  • Chave: document_id_column
  • Valor: tipo STRING. O valor do ID da coluna. entity_params pode ser apenas de um dos tipos a seguir:
params

object (Struct format)

Os parâmetros da entidade para facilitar a ingestão de dados no formato JSON estruturado.
jsonParams

string

Os parâmetros da entidade para facilitar a ingestão de dados no formato de string JSON.

SyncMode

Define o modo de sincronização de dados compatível com o conector de dados.

Tipos enumerados
PERIODIC O conector vai sincronizar os dados periodicamente com base no refreshInterval. Use com autoRunDisabled para pausar a sincronização periódica ou indicar uma sincronização única.
STREAMING Os dados serão sincronizados em tempo real.
UNSPECIFIED Conectores que não ingerem dados terão esse valor

DestinationConfig

Define endpoints de destino usados para se conectar a fontes de terceiros.

Representação JSON 
{
  "key": string,
  "destinations": [
    {
      object (Destination)
    }
  ],

  // Union field destination_config_params can be only one of the following:
  "params": {
    object
  },
  "jsonParams": string
  // End of list of possible types for union field destination_config_params.
}
Campos
key

string

Opcional. Identificador exclusivo do destino compatível com o conector.
destinations[]

object (Destination)

Opcional. Os destinos da chave correspondente.
Campo de união destination_config_params. Parâmetros adicionais para essa configuração de destino. destination_config_params pode ser apenas de um dos tipos a seguir:
params

object (Struct format)

Opcional. Parâmetros adicionais para essa configuração de destino no formato JSON estruturado.
jsonParams

string

Parâmetros adicionais para essa configuração de destino no formato de string JSON.

Destino

Define um endpoint de destino.

Representação JSON 
{
  "port": integer,

  // Union field destination can be only one of the following:
  "host": string
  // End of list of possible types for union field destination.
}
Campos
port

integer

Opcional. Número da porta de destino aceita pelo destino.
Campo de união destination. O destino do endpoint. destination pode ser apenas de um dos tipos a seguir:
host

string

Host roteável publicamente.

ActionConfig

Informações para apoiar ações no conector.

Representação JSON 
{
  "isActionConfigured": boolean,
  "serviceName": string,
  "useStaticSecrets": boolean,

  // Union field action_config_params can be only one of the following:
  "actionParams": {
    object
  },
  "jsonActionParams": string
  // End of list of possible types for union field action_config_params.
}
Campos
isActionConfigured

boolean

Apenas saída. O conector tem os parâmetros necessários e está configurado para oferecer suporte a ações.
serviceName

string

Opcional. O nome do recurso do Service Directory (projects/*/locations/*/namespaces/*/services/*) que representa um endpoint de rede VPC usado para se conectar ao instance_uri da fonte de dados, definido em DataConnector.params.

Obrigatório quando o VPC Service Controls está ativado.
useStaticSecrets

boolean

Opcional. Se é para usar secrets estáticos para o conector. Se for "true", os secrets fornecidos em "actionParams" serão ignorados.

Campo de união action_config_params. Parâmetros necessários para oferecer suporte a ações no formato de pares (chave, valor). Os valores de string com o formato projects/*/[locations/*/]secrets/*/versions/* serão lidos do Secret Manager.

Parâmetros obrigatórios para fontes que aceitam OAuth, ou seja, gmail, google_calendar, jira, workday, salesforce, confluence:

  • Chave: client_id
  • Valor: tipo STRING. O ID do cliente para o provedor de serviços identificar seu aplicativo.
  • Chave: client_secret
  • Valor:tipo STRING. A chave secreta do cliente gerada pelo servidor de autorização do aplicativo. action_config_params pode ser apenas de um dos tipos a seguir:
actionParams

object (Struct format)

Opcional. Parâmetros de ação em formato JSON estruturado.
jsonActionParams

string

Opcional. Parâmetros de ação no formato de string JSON.

EndUserConfig

Parâmetros e credenciais usados especificamente para conectores da UEA.

Representação JSON 
{
  "additionalParams": {
    object
  },
  "tenant": {
    object (Tenant)
  },

  // Union field auth_config can be only one of the following:
  "authParams": {
    object
  },
  "jsonAuthParams": string
  // End of list of possible types for union field auth_config.
}
Campos
additionalParams

object (Struct format)

Opcional. Outros parâmetros necessários para os EUA.
tenant

object (Tenant)

Opcional. O projeto de locatário a que o conector está conectado.
Campo de união auth_config. Configuração de autenticação para conectores da EUA. auth_config pode ser apenas de um dos tipos a seguir:
authParams

object (Struct format)

Opcional. Parâmetros de autenticação específicos para conectores da EUA.
jsonAuthParams

string

Opcional. Parâmetros de autenticação específicos para conectores da EUA no formato de string JSON.

Locatário

Informações do locatário para uma origem de conector. Isso inclui algumas das mesmas informações armazenadas na mensagem de credencial, mas se limita apenas ao que é necessário para fornecer uma lista de locatários acessíveis ao usuário.

Representação JSON 
{
  "id": string,
  "uri": string,
  "displayName": string
}
Campos
id

string

O ID da instância do locatário. Exemplos: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").
uri

string

O URI do locatário, se aplicável. Por exemplo, o URI de uma instância do Jira é https://my-jira-instance.atlassian.net, e um locatário do Slack não tem um URI.
displayName

string

Nome de exibição opcional para o locatário, por exemplo, "Minha equipe do Slack".

FederatedConfig

Todos os parâmetros e credenciais usados especificamente para conectores híbridos que oferecem suporte ao modo FEDERATED.

Representação JSON 
{
  "additionalParams": {
    object
  },

  // Union field auth_config can be only one of the following:
  "authParams": {
    object
  },
  "jsonAuthParams": string
  // End of list of possible types for union field auth_config.
}
Campos
additionalParams

object (Struct format)

Opcional. Todos os parâmetros adicionais necessários para FEDERATED.
Campo de união auth_config. Configuração de autenticação para conectores FEDERADOS. auth_config pode ser apenas de um dos tipos a seguir:
authParams

object (Struct format)

Opcional. Parâmetros de autenticação específicos para conectores FEDERATED.
jsonAuthParams

string

Opcional. Parâmetros de autenticação específicos para conectores FEDERATED no formato de string JSON.

ConnectorMode

Os modos ativados para este conector. INGESTION, ACTIONS, FEDERATED, OR EUA

Tipos enumerados
CONNECTOR_MODE_UNSPECIFIED Modo de conector não especificado.
DATA_INGESTION Conector usado para ingestão de dados.
ACTIONS Conector usado para ações.
FEDERATED Conector usado para pesquisa federada.
EUA Conector usado para autenticação de usuário final.
FEDERATED_AND_EUA Conector híbrido usado para pesquisa federada e autenticação de usuário final.

BlockingReason

Ações do usuário que precisam ser concluídas antes que o conector possa começar a sincronizar dados.

Tipos enumerados
BLOCKING_REASON_UNSPECIFIED Valor padrão.
ALLOWLIST_STATIC_IP O conector exige que o cliente coloque IPs estáticos na lista de permissões.
ALLOWLIST_IN_SERVICE_ATTACHMENT O conector exige que o cliente adicione nosso projeto à lista de permissões no anexo de serviço.
ALLOWLIST_SERVICE_ACCOUNT O conector exige que o cliente coloque a conta de serviço na lista de permissões do projeto.

IdentityScheduleConfig

A configuração das execuções de sincronização de dados de identidade.

Representação JSON 
{
  "refreshInterval": string,
  "nextSyncTime": {
    object (DateTime)
  }
}
Campos
refreshInterval

string (Duration format)

Opcional. O intervalo de atualização para sincronizar as informações da lista de controle de acesso dos documentos ingeridos por esse conector. Se não for definida, a lista de controle de acesso será atualizada no intervalo padrão de 30 minutos. O intervalo de atualização da identidade pode ser de no mínimo 30 minutos e no máximo 7 dias.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
nextSyncTime

object (DateTime)

Opcional. O horário UTC em que a próxima sincronização de dados deve começar para o conector de dados. Os clientes só podem especificar a hora e o minuto para programar a sincronização de dados. Isso é usado quando o conector de dados tem um intervalo de atualização maior que um dia.

BAPConfig

A configuração do conector BAP.

Representação JSON 
{
  "supportedConnectorModes": [
    enum (ConnectorMode)
  ],
  "enabledActions": [
    string
  ]
}
Campos
supportedConnectorModes[]

enum (ConnectorMode)

Obrigatório. Os modos de conector compatíveis com a conexão BAP associada.
enabledActions[]

string

Opcional. As ações ativadas na conexão do BAP associada.

ConnectorMode

Casos de uso compatíveis com esse conector BAP.

Tipos enumerados
CONNECTOR_MODE_UNSPECIFIED Modo de conector não especificado.
DATA_INGESTION Conector usado para ingestão de dados.
ACTIONS Conector usado para ações
END_USER_AUTHENTICATION Conector usado para autenticação de usuário final.

ConnectorType

O tipo de conector.

Tipos enumerados
CONNECTOR_TYPE_UNSPECIFIED Valor padrão.
THIRD_PARTY Conector de terceiros para aplicativo de terceiros.
GCP_FHIR O conector de dados faz a conexão entre o armazenamento FHIR e o armazenamento de dados do VAIS.
BIG_QUERY Conector do BigQuery.
GCS Conector do Google Cloud Storage.
GOOGLE_MAIL Conector do Gmail.
GOOGLE_CALENDAR Conector do Google Agenda.
GOOGLE_DRIVE Conector do Google Drive.
NATIVE_CLOUD_IDENTITY Conector nativo do Cloud Identity para pesquisa de pessoas com tecnologia da API People.
THIRD_PARTY_FEDERATED Conector federado, que é um conector de terceiros que não ingere dados, e a pesquisa é feita pela API do aplicativo de terceiros.
THIRD_PARTY_EUA Conector usado para recursos de autenticação de usuário final.
GCNV Conector do Google Cloud NetApp Volumes.

AlertPolicyConfig

A configuração de alerta no nível do conector.

Representação JSON 
{
  "alertPolicyName": string,
  "alertEnrollments": [
    {
      object (AlertEnrollment)
    }
  ]
}
Campos
alertPolicyName

string

Imutável. O nome totalmente qualificado do recurso AlertPolicy.
alertEnrollments[]

object (AlertEnrollment)

Opcional. Os estados de inscrição de cada alerta.

AlertEnrollment

O status de inscrição do alerta.

Representação JSON 
{
  "alertId": string,
  "enrollState": enum (EnrollStates)
}
Campos
alertId

string

Imutável. O ID de um alerta.
enrollState

enum (EnrollStates)

Obrigatório. O status de inscrição de um cliente.

EnrollStates

A enumeração do status de inscrição do alerta.

Tipos enumerados
ENROLL_STATES_UNSPECIFIED Valor padrão. Usado para clientes que não responderam à política de alertas.
ENROLLED O cliente está inscrito nessa política.
DECLINED O cliente recusou esta política.

RealtimeSyncConfig

A configuração para sincronização em tempo real que armazena parâmetros adicionais para esse tipo de sincronização.

Representação JSON 
{
  "webhookUri": string,
  "realtimeSyncSecret": string,
  "streamingError": {
    object (StreamingError)
  }
}
Campos
webhookUri

string

Opcional. URL do webhook para o conector especificar parâmetros adicionais para a sincronização em tempo real.
realtimeSyncSecret

string

Opcional. O ID do secret do Secret Manager usado para o secret do webhook.
streamingError

object (StreamingError)

Opcional. Detalhes do erro de streaming.

StreamingError

Detalhes do erro de streaming.

Representação JSON 
{
  "streamingErrorReason": enum (StreamingErrorReason),
  "error": {
    object (Status)
  }
}
Campos
streamingErrorReason

enum (StreamingErrorReason)

Opcional. Erro de streaming.
error

object (Status)

Opcional. Detalhes do erro.

StreamingErrorReason

Tipos gerais de erros de streaming.

Tipos enumerados
STREAMING_ERROR_REASON_UNSPECIFIED Motivo do erro de transmissão não especificado.
STREAMING_SETUP_ERROR Ocorreu um erro ao configurar recursos para a sincronização em tempo real.
STREAMING_SYNC_ERROR Ocorreu um erro ao executar a sincronização em tempo real para o conector.
INGRESS_ENDPOINT_REQUIRED O endpoint de entrada é obrigatório ao configurar a sincronização em tempo real na conectividade particular.