REST Resource: projects.locations.collections

Recurso: Collection

Uma coleção é um contêiner para configurar recursos e acesso a um conjunto de DataStores.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "dataConnector": {
    object (DataConnector)
  },
  "createTime": string
}
Campos
name

string

Imutável. O nome completo do recurso da coleção. Formato: projects/{project}/locations/{location}/collections/{collectionId}.

Esse campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
displayName

string

Obrigatório. O nome de exibição da coleção.

Esse campo precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.
dataConnector

object (DataConnector)

Apenas saída. O conector de dados, se presente, gerencia a conexão para repositórios de dados na coleção. Para configurar o conector, use o método DataConnectorService.SetUpDataConnector, que cria um novo Collection ao configurar o recurso singleton DataConnector. Não é possível configurar o conector em um Collection atual.

Esse campo somente de saída contém um subconjunto dos campos DataConnector, incluindo name, dataSource, entities.entity_name e entities.data_store.

Para mais detalhes sobre um conector de dados, use o método DataConnectorService.GetDataConnector.
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora em que o Collection 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".

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
  ],
  "oauthStaticIpAddresses": [
    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,
  "dataProtectionPolicy": {
    object (DataProtectionPolicy)
  },
  "egressFqdns": [
    string
  ],
  "vpcscEnabled": boolean,
  "dynamicTools": [
    {
      object (DynamicTool)
    }
  ],
  "cliConfig": {
    object (CliConfig)
  },
  "connectorSourceId": string,
  "tag": string,
  "metadata": {
    object (ConnectorMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "params": {
    object
  },
  "jsonParams": string
  // End of mutually exclusive fields.
}
Campos
name

string

Identificador. O nome completo do recurso do conector de dados. Formato: projects/*/locations/*/collections/*/dataConnector.
state

enum (State)

Somente saída. Estado do conector.
dataSource

string

Obrigatório. O identificador da fonte de dados. Para conferir a lista completa e atualizada de conectores compatíveis e os valores deles, consulte Conectar uma fonte de dados de terceiros.
removeParamKeys[]

string

Opcional. Especifica as chaves a serem removidas do campo "params". Isso só fica ativo quando "params" é 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 fusos horários 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 0h00. 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. Todos os destinos usados 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 seja compatível com ações.
endUserConfig

object (EndUserConfig)

Opcional. Todos os parâmetros e credenciais usados especificamente para conectores da EUA.
federatedConfig

object (FederatedConfig)

Opcional. Parâmetros e credenciais usados especificamente para conectores híbridos que oferecem suporte ao modo FEDERATED. Esse campo só precisa 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. 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 conector.
oauthStaticIpAddresses[]

string

Apenas saída. Os endereços IP estáticos usados por esse conector para APIs OAuth (por exemplo, autenticação do usuário final). Eles são apresentados separadamente de staticIpAddresses para que os clientes possam aplicar configurações granulares de firewall para endpoints OAuth. Só é preenchido para conectores que têm IP estático ativado e são usados para ações e/ou pesquisa federada.
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 definido, 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 de locatário associado aos conectores de conectividade particular. O 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 é mutável depois de definido pelo sistema.
realtimeState

enum (State)

Somente 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 afeta apenas os conectores do Cloud Storage e do BigQuery.
createEuaSaas

boolean

Opcional. Se o conector de AUTENTICAÇÃO DO USUÁRIO FINAL 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 este 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 vão usar 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.
dataProtectionPolicy

object (DataProtectionPolicy)

Opcional. Especifica a política de proteção de dados do conector.
egressFqdns[]

string

Apenas saída. A lista de FQDNs para onde o conector de dados pode fazer saída. Isso inclui o FQDN derivado do URL da instância fornecido pelo cliente e os FQDNs padrão por tipo de conector.
vpcscEnabled

boolean

Apenas saída. Se o conector foi criado com o VPC-SC ativado.
dynamicTools[]

object (DynamicTool)

Apenas saída. As ferramentas dinâmicas buscadas para este conector.
cliConfig

object (CliConfig)

Opcional. A configuração para estabelecer uma conexão de CLI.
connectorSourceId

string

Opcional. Se definido, esse valor em vez de dataSource será usado para buscar a origem do conector correspondente.
tag

string

Opcional. Imutável. Rótulo independente da versão e voltado ao usuário para este conector. Pode ser compartilhado por vários conectores no mesmo (projeto, local, coleção, dataSource). A pesquisa baseada em tag retorna aquele com o maior createTime.

Opcional no momento da criação. Se o caller omitir tag, o servidor vai derivar automaticamente um de collectionId (voltando para dataSource ou um sentinel t-<micros> baseado em tempo). A tag derivada automaticamente está sujeita à mesma garantia de imutabilidade de uma fornecida pelo caller. Portanto, os callers que se preocupam com o valor exato da tag precisam fornecê-la explicitamente em vez de depender do padrão do servidor.

O Agent Designer resolve conectores usando (dataSource, tag) quando definido, voltando para a pesquisa legada de resourceName quando não definido. Assim, os conectores criados antes do lançamento da gravação de tag continuam funcionando sem um backfill.
metadata

object (ConnectorMetadata)

Opcional. Metadados voltados ao usuário para o conector. Preenchido com os metadados gerados do conector / registro ConnectorSource.

Parâmetros necessários para acessar a origem no formato de pares (chave, valor). 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 o UCS receber um novo token de acesso sem interação do usuário.

Parâmetros obrigatórios para fontes que aceitam a autenticação básica de token de API, ou seja, jira, 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, que é 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 compatibilidade com vários tipos de autorização:

  • Chave: auth_type
  • Valor: tipo STRING. O tipo de autorização da fonte de dados. Valores compatíveis: BASIC_AUTH, OAUTH, OAUTH_ACCESS_TOKEN, OAUTH_TWO_LEGGED, OAUTH_JWT_BEARER, OAUTH_PASSWORD_GRANT, JWT, API_TOKEN, FEDERATED_CREDENTIAL, NO_AUTH. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
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.
Fim dos campos mutuamente exclusivos.

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 causas possíveis incluem erros de tempo de execução ou problemas no pipeline assíncrono, impedindo que a solicitação chegue aos serviços downstream (exceto para alguns tipos de conector).
UPDATING O conector está sendo atualizado.

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)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "params": {
    object
  },
  "jsonParams": string
  // End of mutually exclusive fields.
}
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 de início 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 collections.getDataConnector. Para extrair 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.

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. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
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.
Fim dos campos mutuamente exclusivos.

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 Conector que não ingere dados terá esse valor

DestinationConfig

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "params": {
    object
  },
  "jsonParams": string
  // End of mutually exclusive fields.
}
Campos
key

string

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

object (Destination)

Opcional. Os destinos da chave correspondente.
Parâmetros adicionais para essa configuração de destino. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
params

object (Struct format)

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

string

Outros parâmetros para essa configuração de destino no formato de string JSON.
Fim dos campos mutuamente exclusivos.

Destino

Define um endpoint de destino.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "host": string
  // End of mutually exclusive fields.
}
Campos
port

integer

Opcional. Número da porta de destino aceita pelo destino.
O destino do endpoint. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
host

string

Host roteável publicamente.
Fim dos campos mutuamente exclusivos.

ActionConfig

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

Representação JSON 
{
  "isActionConfigured": boolean,
  "serviceName": string,
  "useStaticSecrets": boolean,
  "createBapConnection": boolean,
  "userDefinedScopesMapping": {
    string: {
      object (ScopeList)
    },
    ...
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionParams": {
    object
  },
  "jsonActionParams": string
  // End of mutually exclusive fields.
}
Campos
isActionConfigured

boolean

Apenas saída. O conector contém 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 instanceUri da fonte de dados, definido em DataConnector.params.

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

boolean

Opcional. Se os secrets estáticos serão usados para o conector. Se for verdadeiro, os segredos fornecidos em actionParams serão ignorados.
createBapConnection

boolean

Opcional. Se uma conexão BAP será criada para o conector.
userDefinedScopesMapping

map (key: string, value: object (ScopeList))

Opcional. Mapeamento do nome da operação para a lista de escopos. Só será preenchido se houver escopos especificados pelo usuário.

Parâmetros necessários para oferecer suporte a ações no formato de pares (chave, valor). 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. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
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.
Fim dos campos mutuamente exclusivos.

ScopeList

Armazena uma lista de escopos.

Representação JSON 
{
  "scopes": [
    string
  ]
}
Campos
scopes[]

string

Opcional. A lista de escopos.

EndUserConfig

Todos os parâmetros e credenciais usados especificamente para conectores da EUA.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "authParams": {
    object
  },
  "jsonAuthParams": string
  // End of mutually exclusive fields.
}
Campos
additionalParams

object (Struct format)

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

object (Tenant)

Opcional. O projeto do locatário a que o conector está conectado.

Configuração de autenticação para conectores da EUA.

Ambos os braços têm parâmetros de autenticação fornecidos pelo cliente, incluindo chaves privadas PEM. Sem um tipo semântico de redação, DebugString() imprime o material principal na íntegra. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
authParams

object (Struct format)

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

string

Opcional. Qualquer parâmetro de autenticação específico para conectores da EUA no formato de string JSON.
Fim dos campos mutuamente exclusivos.

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 é limitado 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") e 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
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "authParams": {
    object
  },
  "jsonAuthParams": string
  // End of mutually exclusive fields.
}
Campos
additionalParams

object (Struct format)

Opcional. Todos os parâmetros adicionais necessários para FEDERATED.
Configuração de autenticação para conectores FEDERADOS. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
authParams

object (Struct format)

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

string

Opcional. Qualquer parâmetro de autenticação específico para conectores FEDERADOS no formato de string JSON.
Fim dos campos mutuamente exclusivos.

ConnectorMode

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

Tipos enumerados
CONNECTOR_MODE_UNSPECIFIED Modo do 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 adicione a conta de serviço à lista de permissões no 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 definido, 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
  ],
  "toolspecOverride": {
    object (ToolspecOverride)
  }
}
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 associada do BAP.
toolspecOverride

object (ToolspecOverride)

Opcional. Substituições de toolspec personalizadas para esta conexão. Para conectores do BAP empresarial que oferecem suporte a definições de ferramentas selecionadas pelo administrador, isso contém as substituições (simplificadas) por ferramenta. Em "Get", preenchido pelo servidor mesclando substituições persistentes com definições de ferramentas de tempo de execução ativas e cortando o resultado para consumo da UI. Na atualização, o valor fornecido substitui as substituições persistentes após a validação e a fusão do lado do servidor: o campo baseVersion PRECISA corresponder à versão atual da especificação de ferramenta base do servidor. Caso contrário, a solicitação será rejeitada com um erro voltado ao usuário, orientando o administrador a baixar novamente as ferramentas mais recentes primeiro.

ConnectorMode

Casos de uso compatíveis com esse conector do BAP.

Tipos enumerados
CONNECTOR_MODE_UNSPECIFIED Modo do 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.

ToolspecOverride

Visualização para o cliente da especificação de ferramenta selecionada pelo administrador para uma conexão BAP. Contém as definições (simplificadas) por ferramenta apresentadas e editáveis pelo administrador na interface do Discovery Engine.

Reflete o formato da mensagem google.cloud.connectorexecution.v1.ToolspecOverride do back-end, mas é mantido intencionalmente como um tipo público separado para que a plataforma da API Discovery Engine possa evoluir de forma independente da plataforma da API fed (AIP-215). Os manipuladores fazem a conversão entre os dois usando helpers em //cloud/ml/discoveryengine/external_service/v1main/data_connector_service/lib:bap_custom_tool_util.

Representação JSON 
{
  "tools": [
    {
      object
    }
  ],
  "baseVersion": string
}
Campos
tools[]

object (Struct format)

Obrigatório. Definições de ferramentas (uma struct por ferramenta) que o administrador personalizou com base na ToolSpec básica retornada pela API federada. OBRIGATÓRIO porque é o único campo editável pelo usuário na API de modificação. A solicitação precisa ter pelo menos uma ferramenta.
baseVersion

string

Obrigatório. Versão base do toolspec em que tools foi criado. Na atualização, precisa corresponder à versão atual e estável da toolspec do servidor para a conexão. Uma incompatibilidade é rejeitada com um erro voltado ao usuário, orientando o administrador a baixar novamente as ferramentas mais recentes primeiro.

ConnectorType

O tipo de conector. Novos valores podem ser adicionados a esse tipo enumerado no futuro.

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 repositório FHIR e o repositório 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 O conector federado é 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.
GOOGLE_CHAT Conector do Google Chat.
GOOGLE_SITES Conector do Google Sites.
REMOTE_MCP Conector remoto baseado em MCP.
GOOGLE_WORKSPACE Conector do Google Workspace.

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 da 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

O tipo enumerado do status de registro 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 extras 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 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 O motivo do erro de streaming não foi especificado.
STREAMING_SETUP_ERROR Ocorreu um erro ao configurar recursos para sincronização em tempo real.
STREAMING_SYNC_ERROR Ocorreu um erro ao executar a sincronização em tempo real do conector.
INGRESS_ENDPOINT_REQUIRED O endpoint de entrada é obrigatório ao configurar a sincronização em tempo real na conectividade particular.

DynamicTool

Configuração para ferramentas dinâmicas.

Representação JSON 
{
  "name": string,
  "description": string,
  "enabled": boolean,
  "displayName": string
}
Campos
name

string

Obrigatório. O nome da ferramenta.
description

string

Opcional. A descrição da ferramenta.
enabled

boolean

Opcional. Se a ferramenta está ativada.
displayName

string

Opcional. O nome de exibição da ferramenta.

CliConfig

A configuração para os conectores baseados na execução da CLI.

Representação JSON 
{
  "enabledActions": [
    string
  ]
}
Campos
enabledActions[]

string

Opcional. As ações ativadas na conexão da CLI associada.

Métodos

delete

 Exclui um Collection.

get

 Recebe um Collection.

getDataConnector

 Recebe o DataConnector.

getIamPolicy

 Recebe a política de controle de acesso do IAM para um Collection.

list

 Recebe uma lista de Collections.

patch

 Atualiza um Collection.

setIamPolicy

 Define a política de controle de acesso do IAM para um Collection.

updateDataConnector

 Atualiza um DataConnector.