- Representación JSON
- Estado
- SourceEntity
- SyncMode
- DestinationConfig
- Destino
- ActionConfig
- EndUserConfig
- Inquilino
- FederatedConfig
- ConnectorMode
- BlockingReason
- IdentityScheduleConfig
- BAPConfig
- ConnectorMode
- ConnectorType
- AlertPolicyConfig
- AlertEnrollment
- EnrollStates
- RealtimeSyncConfig
- StreamingError
- StreamingErrorReason
Gestiona la conexión a fuentes de datos externas de todos los almacenes de datos agrupados en un Collection
. Es un recurso singleton de Collection
. La inicialización solo se admite a través del método DataConnectorService.SetUpDataConnector
, que creará un nuevo Collection
e inicializará su DataConnector
.
Representación JSON |
---|
{ "name": string, "state": enum ( |
Campos | |
---|---|
name |
Solo de salida. Nombre de recurso completo del conector de datos. Formato: |
state |
Solo de salida. Estado del conector. |
dataSource |
Obligatorio. El nombre de la fuente de datos. Valores admitidos: |
removeParamKeys[] |
Opcional. Especifica las claves que se van a quitar del campo "params". Solo está activo cuando se incluye "params" en "updateMask" en un UpdateDataConnectorRequest. La eliminación tiene prioridad si una clave está tanto en "removeParamKeys" como en el campo "params" de la solicitud. |
refreshInterval |
Obligatorio. El intervalo de actualización de la sincronización de datos. Si la duración es 0, los datos se sincronizarán en tiempo real. La función de streaming aún no está disponible. El mínimo es de 30 minutos y el máximo es de 7 días. Si el intervalo de actualización es el mismo que el intervalo de actualización incremental, la sincronización incremental se inhabilitará. Duración en segundos con hasta nueve decimales, que termina con " |
nextSyncTime |
Define la hora programada para la próxima sincronización de datos. Este campo requiere la hora, los minutos y la zona horaria de la base de datos de zonas horarias de IANA. Se utiliza cuando el conector de datos tiene un intervalo de actualización superior a 1 día. Si no se especifican las horas o los minutos, se asumirá que la hora de sincronización es las 0:00. El usuario debe proporcionar una zona horaria para evitar ambigüedades. |
entities[] |
Lista de entidades de la fuente de datos conectada que se van a ingerir. |
createTime |
Solo de salida. Marca de tiempo de la creación de Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: |
latestPauseTime |
Solo de salida. La marca de tiempo más reciente en la que se pausó este Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: |
lastSyncTime |
Solo de salida. Solo en el caso de los conectores periódicos, la última vez que se completó una sincronización de datos. Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: |
updateTime |
Solo de salida. Marca de tiempo de la última actualización del Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: |
errors[] |
Solo de salida. Los errores de inicialización o de la última ejecución del conector. |
syncMode |
El modo de sincronización de datos admitido por el conector de datos. |
kmsKeyName |
Solo de entrada. La clave de KMS que se usará para proteger los almacenes de datos gestionados por este conector. Se debe definir en las solicitudes que deban cumplir las protecciones de la política de organización de CMEK. Si este campo se define y se procesa correctamente, los almacenes de datos creados por este conector estarán protegidos por la clave de KMS. |
destinationConfigs[] |
Opcional. Cualquier destino utilizado para conectarse a servicios de terceros. |
actionState |
Solo de salida. Estado del conector de acción. Esto refleja si el conector de acciones se está inicializando, está activo o ha detectado errores. |
actionConfig |
Opcional. Configuraciones de acciones para que el conector admita acciones. |
endUserConfig |
Opcional. Parámetros y credenciales que se usan específicamente para los conectores de la UEA. |
federatedConfig |
Opcional. Parámetros y credenciales que se usan específicamente para conectores híbridos que admiten el modo FEDERATED. Este campo solo se debe definir si el conector es un conector híbrido y queremos habilitar el modo FEDERATED. |
connectorModes[] |
Opcional. Los modos habilitados para este conector. El estado predeterminado es CONNECTOR_MODE_UNSPECIFIED. |
staticIpEnabled |
Opcional. Indica si el cliente ha habilitado direcciones IP estáticas para este conector. |
staticIpAddresses[] |
Solo de salida. Las direcciones IP estáticas que usa este conector. |
blockingReasons[] |
Solo de salida. Acciones que deben completar los usuarios antes de que el conector pueda empezar a sincronizar datos. |
identityRefreshInterval |
Intervalo de actualización para sincronizar la información de la lista de control de acceso de los documentos insertados por este conector. Si no se establece esta política, la lista de control de acceso se actualizará con el intervalo predeterminado de 30 minutos. El intervalo de actualización de la identidad puede ser de 30 minutos como mínimo y de 7 días como máximo. Duración en segundos con hasta nueve decimales, que termina con " |
identityScheduleConfig |
La configuración de las ejecuciones de sincronización de datos de identidad. Contiene el intervalo de actualización para sincronizar la información de la lista de control de acceso de los documentos insertados por este conector. |
privateConnectivityProjectId |
Solo de salida. Es el ID de proyecto de inquilino asociado a los conectores de conectividad privada. Para que el conector funcione, este proyecto debe estar en la lista de permitidos. |
bapConfig |
Opcional. La configuración para establecer una conexión BAP. |
connectorType |
Solo de salida. El tipo de conector. Cada fuente solo se puede asignar a un tipo. Por ejemplo, Salesforce, Confluence y Jira tienen el tipo de conector THIRD_PARTY. No se puede modificar una vez que el sistema la ha definido. |
realtimeState |
Solo de salida. Estado de sincronización en tiempo real. |
alertPolicyConfigs[] |
Opcional. Configuración de alertas a nivel de conector. |
realtimeSyncConfig |
Opcional. Configuración de la sincronización en tiempo real. |
aclEnabled |
Opcional. Indica si el conector se creará con una configuración de ACL. Actualmente, este campo solo afecta a los conectores de Cloud Storage y BigQuery. |
createEuaSaas |
Opcional. Indica si el conector END USER AUTHENTICATION se ha creado en SaaS. |
autoRunDisabled |
Opcional. Indica si el conector está inhabilitado para la ejecución automática. Se puede usar para pausar la sincronización periódica y en tiempo real. Actualización: Con la introducción de incrementalSyncDisabled, autoRunDisabled se usa para pausar o inhabilitar solo las sincronizaciones completas. |
incrementalSyncDisabled |
Opcional. Indica si las sincronizaciones incrementales están pausadas en este conector. Es independiente de autoRunDisabled. Solo se aplica a los conectores de terceros. Si el intervalo de actualización se define con el mismo valor que el intervalo de actualización incremental, la sincronización incremental se inhabilitará (es decir, se definirá como "true"). |
incrementalRefreshInterval |
Opcional. Intervalo de actualización específico para las sincronizaciones de datos incrementales. Si no se define, las sincronizaciones incrementales usarán el valor predeterminado del entorno, que es de 3 horas. El mínimo es de 30 minutos y el máximo es de 7 días. Solo se aplica a los conectores de terceros. Si el intervalo de actualización es el mismo que el intervalo de actualización incremental, la sincronización incremental se inhabilitará. Duración en segundos con hasta nueve decimales, que termina con " |
hybridIngestionDisabled |
Opcional. Si el conector es un conector híbrido, determina si la ingestión está habilitada y si se aprovisionan los recursos adecuados durante la creación del conector. Si el conector no es un conector híbrido, este campo se ignora. |
Campo de unión Parámetros obligatorios para todas las fuentes de datos:
Parámetros obligatorios para las fuentes que admiten OAuth, es decir,
Parámetros obligatorios para las fuentes que admiten la autenticación básica con token de API, como
Ejemplo:
Parámetro opcional para especificar el tipo de autorización que se va a usar en la compatibilidad con varios tipos de autorización:
|
|
params |
Parámetros obligatorios del conector de datos en formato JSON estructurado. |
jsonParams |
Parámetros obligatorios del conector de datos en formato de cadena JSON. |
Estado
El estado del conector.
Enumeraciones | |
---|---|
STATE_UNSPECIFIED |
Valor predeterminado. |
CREATING |
Se está configurando el conector. |
ACTIVE |
El conector se ha configurado correctamente y está esperando la próxima sincronización. |
FAILED |
El conector tiene un error. Puede consultar los detalles del error en DataConnector.errors . Si el error no se puede solucionar, se puede eliminar el DataConnector con la API [CollectionService.DeleteCollection]. |
RUNNING |
El conector está sincronizando activamente los registros de la fuente de datos. |
WARNING |
El conector ha completado una sincronización, pero ha detectado errores no críticos. |
INITIALIZATION_FAILED |
No se ha podido inicializar el conector. Entre las posibles causas se incluyen errores de tiempo de ejecución o problemas en la canalización asíncrona, lo que impide que la solicitud llegue a los servicios posteriores (excepto en algunos tipos de conectores). |
UPDATING |
El conector está en proceso de actualización. |
SourceEntity
Representa una entidad de la fuente de datos. Por ejemplo, el objeto Account
de Salesforce.
Representación JSON |
---|
{ "entityName": string, "keyPropertyMappings": { string: string, ... }, "dataStore": string, "startingSchema": { object ( |
Campos | |
---|---|
entityName |
Nombre de la entidad. Valores admitidos por fuente de datos:
|
keyPropertyMappings |
Atributos de indexación. Clave: nombre del campo. Valor: propiedad de clave para asignar un campo, como
|
dataStore |
Solo de salida. Nombre de recurso completo del almacén de datos asociado de la entidad de origen. Formato: |
startingSchema |
Opcional. El esquema de inicio que se va a usar para el Este campo solo lo usa la API [SetUpDataConnector][] y se ignorará si se usa en otras APIs. Este campo se omitirá en todas las respuestas de la API, incluida la API [GetDataConnector][]. Para recuperar el esquema de un El esquema proporcionado se validará según determinadas reglas del esquema. Consulta más información en este documento. |
healthcareFhirConfig |
Opcional. Configuración de la vertical |
Campo de unión
|
|
params |
Los parámetros de la entidad para facilitar la ingesta de datos en formato JSON estructurado. |
jsonParams |
Los parámetros de la entidad para facilitar la ingestión de datos en formato de cadena JSON. |
SyncMode
Define el modo de sincronización de datos que admite el conector de datos.
Enumeraciones | |
---|---|
PERIODIC |
El conector sincronizará los datos periódicamente en función de refreshInterval. Úsala con autoRunDisabled para pausar la sincronización periódica o indicar una sincronización única. |
STREAMING |
Los datos se sincronizarán en tiempo real. |
UNSPECIFIED |
Los conectores que no ingieran datos tendrán este valor. |
DestinationConfig
Define los endpoints de destino que se usan para conectarse a fuentes de terceros.
Representación JSON |
---|
{ "key": string, "destinations": [ { object ( |
Campos | |
---|---|
key |
Opcional. Identificador de destino único admitido por el conector. |
destinations[] |
Opcional. Los destinos de la clave correspondiente. |
Campo de unión destination_config_params . Parámetros adicionales de esta configuración de destino. destination_config_params solo puede ser una de estas dos opciones: |
|
params |
Opcional. Parámetros adicionales de esta configuración de destino en formato JSON estructurado. |
jsonParams |
Parámetros adicionales de esta configuración de destino en formato de cadena JSON. |
Destino
Define un endpoint de destino.
Representación JSON |
---|
{ "port": integer, // Union field |
Campos | |
---|---|
port |
Opcional. Número de puerto de destino aceptado por el destino. |
Campo de unión destination . El destino del endpoint. destination solo puede ser una de estas dos opciones: |
|
host |
Host disponible públicamente. |
ActionConfig
Información para admitir acciones en el conector.
Representación JSON |
---|
{ "isActionConfigured": boolean, "serviceName": string, "useStaticSecrets": boolean, // Union field |
Campos | |
---|---|
isActionConfigured |
Solo de salida. El conector contiene los parámetros necesarios y está configurado para admitir acciones. |
serviceName |
Opcional. Nombre del recurso de Directorio de servicios (projects/*/locations/*/namespaces/*/services/*) que representa un punto final de red de VPC usado para conectarse al Obligatorio cuando Controles de Servicio de VPC está habilitado. |
useStaticSecrets |
Opcional. Indica si se deben usar secretos estáticos para el conector. Si se le asigna el valor true, se ignorarán los secretos proporcionados en actionParams. |
Campo de unión Parámetros obligatorios para las fuentes que admiten OAuth, es decir,
|
|
actionParams |
Opcional. Parámetros de acción en formato JSON estructurado. |
jsonActionParams |
Opcional. Parámetros de acción en formato de cadena JSON. |
EndUserConfig
Parámetros y credenciales que se usan específicamente para los conectores de la UEA.
Representación JSON |
---|
{ "additionalParams": { object }, "tenant": { object ( |
Campos | |
---|---|
additionalParams |
Opcional. Cualquier parámetro adicional necesario para el EULA. |
tenant |
Opcional. El proyecto de cliente al que está conectado el conector. |
Campo de unión auth_config . Configuración de autenticación para conectores de EUA. auth_config solo puede ser una de estas dos opciones: |
|
authParams |
Opcional. Parámetros de autenticación específicos de los conectores de EUA. |
jsonAuthParams |
Opcional. Parámetros de autenticación específicos de los conectores de EUA en formato de cadena JSON. |
Cliente
Información del arrendatario de una fuente de conector. Incluye parte de la misma información almacenada en el mensaje Credential, pero se limita a lo que se necesita para proporcionar una lista de arrendatarios accesibles al usuario.
Representación JSON |
---|
{ "id": string, "uri": string, "displayName": string } |
Campos | |
---|---|
id |
El ID de instancia del arrendatario. Por ejemplo, Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0") y Slack ("T123456"). |
uri |
El URI del arrendatario, si procede. Por ejemplo, el URI de una instancia de Jira es https://my-jira-instance.atlassian.net, y un arrendatario de Slack no tiene URI. |
displayName |
Nombre visible opcional del arrendatario, como "Mi equipo de Slack". |
FederatedConfig
Parámetros y credenciales que se usan específicamente para conectores híbridos que admiten el modo FEDERATED.
Representación JSON |
---|
{ "additionalParams": { object }, // Union field |
Campos | |
---|---|
additionalParams |
Opcional. Parámetros adicionales necesarios para FEDERATED. |
Campo de unión auth_config . Configuración de autenticación para conectores FEDERATED. auth_config solo puede ser una de estas dos opciones: |
|
authParams |
Opcional. Parámetros de autenticación específicos de los conectores FEDERATED. |
jsonAuthParams |
Opcional. Parámetros de autenticación específicos de los conectores FEDERATED en formato de cadena JSON. |
ConnectorMode
Los modos habilitados para este conector. INGESTION, ACTIONS, FEDERATED, OR EUA
Enumeraciones | |
---|---|
CONNECTOR_MODE_UNSPECIFIED |
Modo de conector no especificado. |
DATA_INGESTION |
Conector utilizado para la ingestión de datos. |
ACTIONS |
Conector utilizado para las acciones. |
FEDERATED |
Conector utilizado para la búsqueda federada. |
EUA |
Conector utilizado para la autenticación de usuarios finales. |
FEDERATED_AND_EUA |
Conector híbrido utilizado para la búsqueda federada y la autenticación de usuarios finales. |
BlockingReason
Acciones que deben completar los usuarios antes de que el conector pueda empezar a sincronizar datos.
Enumeraciones | |
---|---|
BLOCKING_REASON_UNSPECIFIED |
Valor predeterminado. |
ALLOWLIST_STATIC_IP |
El conector requiere que el cliente incluya IPs estáticas en la lista de permitidos. |
ALLOWLIST_IN_SERVICE_ATTACHMENT |
El conector requiere que el cliente incluya nuestro proyecto en la lista de permitidos de su adjunto de servicio. |
ALLOWLIST_SERVICE_ACCOUNT |
El conector requiere que el cliente incluya en una lista de permitidos la cuenta de servicio en su proyecto. |
IdentityScheduleConfig
La configuración de las ejecuciones de sincronización de datos de identidad.
Representación JSON |
---|
{
"refreshInterval": string,
"nextSyncTime": {
object ( |
Campos | |
---|---|
refreshInterval |
Opcional. Intervalo de actualización para sincronizar la información de la lista de control de acceso de los documentos insertados por este conector. Si no se establece esta política, la lista de control de acceso se actualizará con el intervalo predeterminado de 30 minutos. El intervalo de actualización de la identidad puede ser de 30 minutos como mínimo y de 7 días como máximo. Duración en segundos con hasta nueve decimales, que termina con " |
nextSyncTime |
Opcional. Hora UTC en la que se espera que empiece la próxima sincronización de datos del conector de datos. Los clientes solo pueden especificar la hora y los minutos para programar la sincronización de datos. Se utiliza cuando el conector de datos tiene un intervalo de actualización superior a 1 día. |
BAPConfig
La configuración del conector de BAP.
Representación JSON |
---|
{
"supportedConnectorModes": [
enum ( |
Campos | |
---|---|
supportedConnectorModes[] |
Obligatorio. Los modos de conector admitidos para la conexión BAP asociada. |
enabledActions[] |
Opcional. Las acciones habilitadas en la conexión BAP asociada. |
ConnectorMode
Casos prácticos admitidos por este conector de BAP.
Enumeraciones | |
---|---|
CONNECTOR_MODE_UNSPECIFIED |
Modo de conector no especificado. |
DATA_INGESTION |
Conector utilizado para la ingestión de datos. |
ACTIONS |
Conector utilizado para las acciones |
END_USER_AUTHENTICATION |
Conector utilizado para la autenticación de usuarios finales. |
ConnectorType
El tipo de conector.
Enumeraciones | |
---|---|
CONNECTOR_TYPE_UNSPECIFIED |
Valor predeterminado. |
THIRD_PARTY |
Conector de terceros a conector a aplicación de terceros. |
GCP_FHIR |
El conector de datos conecta el almacén FHIR y el almacén de datos de VAIS. |
BIG_QUERY |
Conector de BigQuery. |
GCS |
Conector de Google Cloud Storage. |
GOOGLE_MAIL |
Conector de Gmail. |
GOOGLE_CALENDAR |
Conector de Google Calendar. |
GOOGLE_DRIVE |
Conector de Google Drive. |
NATIVE_CLOUD_IDENTITY |
Conector nativo de Cloud Identity para la búsqueda de personas que usa la API People. |
THIRD_PARTY_FEDERATED |
Conector federado: es un conector de terceros que no ingiere datos y la búsqueda se basa en la API de la aplicación de terceros. |
THIRD_PARTY_EUA |
Conector utilizado para las funciones de autenticación de usuarios finales. |
GCNV |
Conector de Google Cloud NetApp Volumes. |
AlertPolicyConfig
Configuración de alertas a nivel de conector.
Representación JSON |
---|
{
"alertPolicyName": string,
"alertEnrollments": [
{
object ( |
Campos | |
---|---|
alertPolicyName |
Inmutable. Nombre completo del recurso AlertPolicy. |
alertEnrollments[] |
Opcional. El estado de registro de cada alerta. |
AlertEnrollment
Estado del registro de alertas.
Representación JSON |
---|
{
"alertId": string,
"enrollState": enum ( |
Campos | |
---|---|
alertId |
Inmutable. ID de una alerta. |
enrollState |
Obligatorio. El estado de registro de un cliente. |
EnrollStates
Enumeración del estado de registro de la alerta.
Enumeraciones | |
---|---|
ENROLL_STATES_UNSPECIFIED |
Valor predeterminado. Se usa para los clientes que no han respondido a la política de alertas. |
ENROLLED |
El cliente tiene habilitada esta política. |
DECLINED |
El cliente ha rechazado esta política. |
RealtimeSyncConfig
Configuración de la sincronización en tiempo real para almacenar parámetros adicionales de la sincronización en tiempo real.
Representación JSON |
---|
{
"webhookUri": string,
"realtimeSyncSecret": string,
"streamingError": {
object ( |
Campos | |
---|---|
webhookUri |
Opcional. URL de webhook del conector para especificar parámetros adicionales de la sincronización en tiempo real. |
realtimeSyncSecret |
Opcional. ID del secreto de Secret Manager que se usa para el secreto de webhook. |
streamingError |
Opcional. Detalles del error de streaming. |
StreamingError
Detalles del error de streaming.
Representación JSON |
---|
{ "streamingErrorReason": enum ( |
Campos | |
---|---|
streamingErrorReason |
Opcional. Error de streaming. |
error |
Opcional. Detalles del error. |
StreamingErrorReason
Tipos generales de errores de streaming.
Enumeraciones | |
---|---|
STREAMING_ERROR_REASON_UNSPECIFIED |
No se ha especificado el motivo del error de streaming. |
STREAMING_SETUP_ERROR |
Se ha producido un error al configurar los recursos para la sincronización en tiempo real. |
STREAMING_SYNC_ERROR |
Se ha producido un error al ejecutar la sincronización en tiempo real del conector. |
INGRESS_ENDPOINT_REQUIRED |
El endpoint de entrada es obligatorio al configurar la sincronización en tiempo real en la conectividad privada. |