DataConnector

Gerencia a ligação a origens de dados externas para todos os arquivos de dados agrupados num Collection. É um recurso singleton de Collection. A inicialização só é suportada através do método DataConnectorService.SetUpDataConnector, que cria um novo Collection e inicializa o respetivo DataConnector.

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 conetor de dados. Formato: projects/*/locations/*/collections/*/dataConnector.
state

enum (State)

Apenas saída. Estado do conetor.
dataSource

string

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

string

Opcional. Especifica as chaves a remover do campo "params". Esta opção só está ativa quando "params" está incluído em "updateMask" num UpdateDataConnectorRequest. A eliminação tem precedência se uma chave estiver em "removeParamKeys" e presente no campo "params" do pedido.
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 são sincronizados em tempo real. A funcionalidade de streaming ainda não é suportada. O mínimo é de 30 minutos e o máximo é de 7 dias. Quando o intervalo de atualização é definido com o mesmo valor que o intervalo de atualização incremental, a sincronização incremental é desativada.

Uma duração em segundos com até nove dígitos fracionários, que termina com "s". Exemplo: "3.5s".
nextSyncTime

object (DateTime)

Define a hora agendada para a próxima sincronização de dados. Este campo requer a hora, os minutos e o fuso horário da base de dados de fusos horários da IANA. Esta opção é usada quando o conetor de dados tem um intervalo de atualização superior a 1 dia. Quando as horas ou os minutos não são especificados, assumimos uma hora de sincronização de 0:00. O utilizador tem de indicar um fuso horário para evitar ambiguidades.
entities[]

object (SourceEntity)

Lista de entidades da origem de dados associada a carregar.
createTime

string (Timestamp format)

Apenas saída. Data/hora de criação do DataConnector.

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

string (Timestamp format)

Apenas saída. A data/hora mais recente em que este DataConnector foi pausado, o que afeta todas as funcionalidades, como a sincronização de dados. A pausa de um conetor tem os seguintes efeitos: - Todas as funcionalidades, incluindo a sincronização de dados, são interrompidas. – Todas as tarefas de sincronização de dados em curso são canceladas. – Não são agendadas nem podem ser acionadas execuções de sincronização de dados futuras.

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

string (Timestamp format)

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

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

string (Timestamp format)

Apenas saída. Data/hora da última atualização do DataConnector.

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

object (Status)

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

enum (SyncMode)

O modo de sincronização de dados suportado pelo conetor de dados.
kmsKeyName

string

Apenas entrada. A chave do KMS a usar para proteger os arquivos de dados geridos por este conetor.

Tem de ser definido para pedidos que têm de estar em conformidade com as proteções da política organizacional da CMEK.

Se este campo for definido e processado com êxito, os arquivos de dados criados por este conetor são protegidos pela chave do KMS.
destinationConfigs[]

object (DestinationConfig)

Opcional. Quaisquer destinos usados para estabelecer ligação a serviços de terceiros.
actionState

enum (State)

Apenas saída. Estado do conetor de ações. Isto reflete se o conetor de ações está a ser inicializado, está ativo ou encontrou erros.
actionConfig

object (ActionConfig)

Opcional. Configurações de ações para que o conetor suporte ações.
endUserConfig

object (EndUserConfig)

Opcional. Quaisquer parâmetros e credenciais usados especificamente para conetores da EUA.
federatedConfig

object (FederatedConfig)

Opcional. Quaisquer parâmetros e credenciais usados especificamente para conectores híbridos que suportam o modo FEDERATED. Este campo só deve ser definido se o conetor for um conetor híbrido e quisermos ativar o modo FEDERATED.
connectorModes[]

enum (ConnectorMode)

Opcional. Os modos ativados para este conetor. O estado predefinido é 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 este conetor.
blockingReasons[]

enum (BlockingReason)

Apenas saída. Ações do utilizador que têm de ser concluídas antes de o conector poder começar a sincronizar dados.
identityRefreshInterval
(deprecated)

string (Duration format)

O intervalo de atualização para sincronizar as informações da lista de controlo de acesso dos documentos carregados por este conector. Se não for definida, a lista de controlo de acesso é atualizada no intervalo predefinido de 30 minutos. O intervalo de atualização da identidade pode ser de, pelo menos, 30 minutos e, no máximo, 7 dias.

Uma duração em segundos com até nove dígitos fracionários, que termina com "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 controlo de acesso dos documentos carregados por este conector.
privateConnectivityProjectId

string

Apenas saída. O ID do projeto de inquilino associado aos conetores de conetividade privada. Este projeto tem de constar da lista de autorizações para que o conetor funcione.
bapConfig

object (BAPConfig)

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

enum (ConnectorType)

Apenas saída. O tipo de conetor. Cada origem só pode ser mapeada para um tipo. Por exemplo, o Salesforce, o Confluence e o Jira têm o tipo de conetor THIRD_PARTY. Não é mutável depois de ser definido pelo sistema.
realtimeState

enum (State)

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

object (AlertPolicyConfig)

Opcional. A configuração de alerta ao nível do conetor.
realtimeSyncConfig

object (RealtimeSyncConfig)

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

boolean

Opcional. Se o conetor vai ser criado com uma configuração de ACL. Atualmente, este campo só afeta os conetores do Cloud Storage e do BigQuery.
createEuaSaas

boolean

Opcional. Se o conetor END USER AUTHENTICATION é criado no SaaS.
autoRunDisabled

boolean

Opcional. Indica se o conetor está desativado para execução automática. 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 este conetor. Isto é independente de autoRunDisabled. Aplicável apenas a conetores de terceiros. Quando o intervalo de atualização está definido com o mesmo valor que o intervalo de atualização incremental, a sincronização incremental é desativada, ou seja, definida como verdadeira.
incrementalRefreshInterval

string (Duration format)

Opcional. O intervalo de atualização especificamente para sincronizações de dados incrementais. Se não estiver definida, as sincronizações incrementais usam o valor predefinido do ambiente, definido como 3 horas. O mínimo é de 30 minutos e o máximo é de 7 dias. Aplicável apenas a conetores de terceiros. Quando o intervalo de atualização é definido com o mesmo valor que o intervalo de atualização incremental, a sincronização incremental é desativada.

Uma duração em segundos com até nove dígitos fracionários, que termina com "s". Exemplo: "3.5s".
hybridIngestionDisabled

boolean

Opcional. Se o conetor for um conetor híbrido, determina se o carregamento está ativado e se os recursos adequados são aprovisionados durante a criação do conetor. Se o conetor não for um conetor híbrido, este campo é ignorado.

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

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

  • Tecla: instance_uri
  • Valor: tipo STRING. O URI para aceder à origem de dados.

Parâmetros obrigatórios para origens que suportam o OAUTH, ou seja, salesforce:

  • Tecla: client_id
  • Valor: tipo STRING. O ID de cliente do fornecedor de serviços externo para identificar a sua aplicação.
  • Tecla: client_secret
  • Value:type STRING. O segredo do cliente gerado pelo servidor de autorização de terceiros.
  • Tecla: access_token
  • Valor: tipo STRING. Token OAuth para o UCS aceder ao recurso protegido.
  • Tecla: refresh_token
  • Valor: tipo STRING. Token de atualização do OAuth para o UCS obter um novo token de acesso sem interação do utilizador.

Parâmetros obrigatórios para origens que suportam a autorização básica de chaves da API, ou seja, jira e confluence:

  • Tecla: user_account
  • Valor: tipo STRING. O nome de utilizador ou o email com a origem.
  • Tecla: api_token
  • Valor: tipo STRING. O token da API gerado para a conta de origem, que é usado para autenticação em qualquer lugar onde teria usado uma palavra-passe.

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 usar para suporte de vários tipos de autorização:

  • Tecla: auth_type
  • Valor: tipo STRING. O tipo de autorização da origem de dados. Valores suportados: BASIC_AUTH, OAUTH, OAUTH_ACCESS_TOKEN, OAUTH_TWO_LEGGED, OAUTH_JWT_BEARER, OAUTH_PASSWORD_GRANT, JWT, API_TOKEN e FEDERATED_CREDENTIAL. data_connector_params só pode ser uma das seguintes opções:
params

object (Struct format)

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

string

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

Estado

O estado do conetor.

Enumerações
STATE_UNSPECIFIED Valor predefinido.
CREATING O conetor está a ser configurado.
ACTIVE O conetor está configurado com êxito e a aguardar a próxima execução da sincronização.
FAILED O conetor está com erros. Pode encontrar os detalhes do erro em DataConnector.errors. Se o erro não for corrigível, o DataConnector pode ser eliminado através da API [CollectionService.DeleteCollection].
RUNNING O conetor está a sincronizar ativamente registos da origem de dados.
WARNING O conetor concluiu uma execução de sincronização, mas encontrou erros não fatais.
INITIALIZATION_FAILED Falha na inicialização do conetor. As potenciais causas incluem erros de tempo de execução ou problemas no pipeline assíncrono, o que impede que o pedido chegue aos serviços a jusante (exceto para alguns tipos de conetores).
UPDATING O conetor está em processo de atualização.

SourceEntity

Representa uma entidade na origem 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 suportados por origem de dados:

  • Salesforce: Lead, Opportunity, Contact, Account, Case, Contract e Campaign
  • Jira: Issue
  • Confluência: Content, Space
keyPropertyMappings

map (key: string, value: string)

Atributos para indexação. Key: nome do campo. value: a propriedade da chave para mapear um campo, como title e description. Propriedades de chave suportadas:

  • title: o título do registo de dados. Esta informação seria apresentada nos resultados da pesquisa.
  • description: a descrição do registo de dados. Esta informação é apresentada nos resultados da pesquisa.
dataStore

string

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

object (Schema)

Opcional. O esquema de início a usar para o DataStore criado a partir deste SourceEntity. Se não estiver definida, é usado um esquema especializado vertical predefinido.

Este campo só é usado pela API [SetUpDataConnector][] e é ignorado se for usado noutras APIs. Este campo é omitido de todas as respostas da API, incluindo a API [GetDataConnector][]. Para obter um esquema de um DataStore, use a API SchemaService.GetSchema.

O esquema fornecido é validado em função de determinadas regras no esquema. Saiba mais neste documento.
healthcareFhirConfig

object (HealthcareFhirConfig)

Opcional. Configuração para o vertical HEALTHCARE_FHIR.

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

  • Tecla: document_id_column
  • Valor: tipo STRING. O valor do ID da coluna. entity_params só pode ser uma das seguintes opções:
params

object (Struct format)

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

string

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

SyncMode

Define o modo de sincronização de dados suportado pelo conetor de dados.

Enumerações
PERIODIC O conetor sincroniza os dados periodicamente com base no refreshInterval. Use-o com autoRunDisabled para pausar a sincronização periódica ou indicar uma sincronização única.
STREAMING Os dados são sincronizados em tempo real.
UNSPECIFIED O conetor que não carrega dados tem este valor

DestinationConfig

Define os pontos finais de destino usados para estabelecer ligação a fontes externas.

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 de destino exclusivo suportado pelo conector.
destinations[]

object (Destination)

Opcional. Os destinos da chave correspondente.
Campo de união destination_config_params. Parâmetros adicionais para esta configuração de destino. destination_config_params só pode ser uma das seguintes opções:
params

object (Struct format)

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

string

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

Destino

Define um ponto final 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 aceite pelo destino.
Campo de união destination. O destino do ponto final. destination só pode ser uma das seguintes opções:
host

string

Anfitrião encaminhável publicamente.

ActionConfig

Informações para suportar ações no conetor.

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 conetor contém os parâmetros necessários e está configurado para suportar ações.
serviceName

string

Opcional. O nome do recurso do Service Directory (projects/*/locations/*/namespaces/*/services/*) que representa um ponto final da rede VPC usado para estabelecer ligação ao instance_uri da origem de dados, definido em DataConnector.params.

Obrigatório quando os VPC Service Controls estão ativados.
useStaticSecrets

boolean

Opcional. Se deve usar segredos estáticos para o conetor. Se for verdadeiro, os segredos fornecidos em actionParams são ignorados.

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

Parâmetros obrigatórios para origens que suportam OAUTH, ou seja, gmail, google_calendar, jira, workday, salesforce e confluence:

  • Tecla: client_id
  • Valor: tipo STRING. O ID de cliente do fornecedor de serviços para identificar a sua aplicação.
  • Tecla: client_secret
  • Value:type STRING. O segredo do cliente gerado pelo servidor de autorizações da aplicação. action_config_params só pode ser uma das seguintes opções:
actionParams

object (Struct format)

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

string

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

EndUserConfig

Quaisquer parâmetros e credenciais usados especificamente para conetores da EUA.

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. Quaisquer parâmetros adicionais necessários para a EUA.
tenant

object (Tenant)

Opcional. O projeto de inquilino ao qual o conector está associado.
Campo de união auth_config. Configuração de autenticação para conetores de EUA. auth_config só pode ser uma das seguintes opções:
authParams

object (Struct format)

Opcional. Quaisquer parâmetros de autenticação específicos dos conetores de EUA.
jsonAuthParams

string

Opcional. Quaisquer parâmetros de autenticação específicos dos conetores de EUA no formato de string JSON.

Inquilino

Informações do inquilino para uma origem de conetor. Isto inclui algumas das mesmas informações armazenadas na mensagem Credential, mas limita-se apenas ao que é necessário para fornecer uma lista de inquilinos acessíveis ao utilizador.

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

string

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

string

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

string

Nome a apresentar opcional para o inquilino, por exemplo, "A minha equipa do Slack".

FederatedConfig

Quaisquer parâmetros e credenciais usados especificamente para conectores híbridos que suportam o 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. Quaisquer parâmetros adicionais necessários para FEDERATED.
Campo de união auth_config. Configuração de autenticação para conetores FEDERATED. auth_config só pode ser uma das seguintes opções:
authParams

object (Struct format)

Opcional. Quaisquer parâmetros de autenticação específicos dos conetores FEDERATED.
jsonAuthParams

string

Opcional. Quaisquer parâmetros de autenticação específicos dos conetores FEDERATED no formato de string JSON.

ConnectorMode

Os modos ativados para este conetor. INGESTION, ACTIONS, FEDERATED OU EUA

Enumerações
CONNECTOR_MODE_UNSPECIFIED Modo do conetor não especificado.
DATA_INGESTION Conetor usado para a obtenção de dados.
ACTIONS Conetor usado para ações.
FEDERATED Conetor usado para a pesquisa federada.
EUA Conetor usado para a autenticação do utilizador final.
FEDERATED_AND_EUA Conetor híbrido usado para a pesquisa federada e a autenticação do utilizador final.

BlockingReason

Ações do utilizador que têm de ser concluídas antes de o conector poder começar a sincronizar dados.

Enumerações
BLOCKING_REASON_UNSPECIFIED Valor predefinido.
ALLOWLIST_STATIC_IP O conector requer que o cliente adicione IPs estáticos à lista de autorizações.
ALLOWLIST_IN_SERVICE_ATTACHMENT O conector requer que o cliente inclua o nosso projeto na lista de autorizações da respetiva associação de serviço.
ALLOWLIST_SERVICE_ACCOUNT O conector requer que o cliente inclua a conta de serviço na lista de autorizações do respetivo 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 controlo de acesso dos documentos carregados por este conector. Se não for definida, a lista de controlo de acesso é atualizada no intervalo predefinido de 30 minutos. O intervalo de atualização da identidade pode ser de, pelo menos, 30 minutos e, no máximo, 7 dias.

Uma duração em segundos com até nove dígitos fracionários, que termina com "s". Exemplo: "3.5s".
nextSyncTime

object (DateTime)

Opcional. A hora UTC em que se espera que a próxima sincronização de dados seja iniciada para o conetor de dados. Os clientes só podem especificar a hora e os minutos para agendar a sincronização de dados. Esta opção é usada quando o conetor de dados tem um intervalo de atualização superior a 1 dia.

BAPConfig

A configuração do conetor BAP.

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

enum (ConnectorMode)

Obrigatório. Os modos de conector suportados para a ligação BAP associada.
enabledActions[]

string

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

ConnectorMode

Exemplos de utilização suportados por este conetor BAP.

Enumerações
CONNECTOR_MODE_UNSPECIFIED Modo do conetor não especificado.
DATA_INGESTION Conetor usado para a obtenção de dados.
ACTIONS Conetor usado para ações
END_USER_AUTHENTICATION Conetor usado para a autenticação do utilizador final.

ConnectorType

O tipo de conetor.

Enumerações
CONNECTOR_TYPE_UNSPECIFIED Valor predefinido.
THIRD_PARTY Conector de terceiros para aplicação de terceiros.
GCP_FHIR O conector de dados estabelece a ligação entre o FHIR store e o VAIS datastore.
BIG_QUERY Conetor do BigQuery.
GCS Conetor do Google Cloud Storage.
GOOGLE_MAIL Conector do Gmail.
GOOGLE_CALENDAR Conetor do Calendário Google.
GOOGLE_DRIVE Conector do Google Drive.
NATIVE_CLOUD_IDENTITY Conetor nativo do Cloud Identity para a pesquisa de pessoas com tecnologia da API People.
THIRD_PARTY_FEDERATED Conetor federado: é um conetor de terceiros que não carrega dados, e a pesquisa é alimentada pela API da aplicação de terceiros.
THIRD_PARTY_EUA Conetor usado para funcionalidades de autenticação do utilizador final.
GCNV Conetor do Google Cloud NetApp Volumes.

AlertPolicyConfig

A configuração de alerta ao nível do conetor.

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

string

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

object (AlertEnrollment)

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

AlertEnrollment

O estado 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 estado de inscrição de um cliente.

EnrollStates

A enumeração do estado de inscrição para o alerta.

Enumerações
ENROLL_STATES_UNSPECIFIED Valor predefinido. Usado para clientes que não responderam à política de alertas.
ENROLLED O cliente está inscrito nesta política.
DECLINED O cliente recusou esta política.

RealtimeSyncConfig

A configuração para a sincronização em tempo real para armazenar parâmetros adicionais para a sincronização em tempo real.

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

string

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

string

Opcional. O ID do Secret do Secret Manager usado para o segredo 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.

Enumerações
STREAMING_ERROR_REASON_UNSPECIFIED Motivo do erro de streaming não especificado.
STREAMING_SETUP_ERROR Ocorreu um erro ao configurar os recursos para a sincronização em tempo real.
STREAMING_SYNC_ERROR Ocorreu um erro ao executar a sincronização em tempo real para o conetor.
INGRESS_ENDPOINT_REQUIRED O ponto final de entrada é obrigatório quando configura a sincronização em tempo real na conetividade privada.