- Representación JSON
- Estado
- SourceEntity
- SyncMode
- DestinationConfig
- Destino
- ActionConfig
- EndUserConfig
- Tenant
- FederatedConfig
- ConnectorMode
- BlockingReason
- IdentityScheduleConfig
- BAPConfig
- ConnectorMode
- ConnectorType
- AlertPolicyConfig
- AlertEnrollment
- EnrollStates
- RealtimeSyncConfig
- StreamingError
- StreamingErrorReason
Administra la conexión a fuentes de datos externas para 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
y, luego, inicializará su DataConnector
.
Representación JSON |
---|
{ "name": string, "state": enum ( |
Campos | |
---|---|
name |
Solo salida. Es el nombre completo del recurso del conector de datos. Formato: |
state |
Solo salida. Es el estado del conector. |
dataSource |
Obligatorio. Es el nombre de la fuente de datos. Valores admitidos: |
removeParamKeys[] |
Opcional. Especifica las claves que se quitarán del campo "params". Solo está activo cuando se incluye "params" en "updateMask" en un UpdateDataConnectorRequest. La eliminación tiene prioridad si una clave se encuentra en "removeParamKeys" y está presente en el campo "params" de la solicitud. |
refreshInterval |
Obligatorio. Es el intervalo de actualización de la sincronización de datos. Si la duración se establece en 0, los datos se sincronizarán en tiempo real. Aún no se admite la función de transmisión. El mínimo es de 30 minutos y el máximo es de 7 días. Cuando el intervalo de actualización se establece en el mismo valor que el intervalo de actualización incremental, se inhabilitará la sincronización incremental. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
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. Cuando no se especifican las horas o los minutos, se supondrá que la hora de sincronización es las 0:00. El usuario debe proporcionar una zona horaria para evitar ambigüedades. |
entities[] |
Es la lista de entidades de la fuente de datos conectada que se deben transferir. |
createTime |
Solo salida. Es la marca de tiempo en la que se creó el objeto Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
latestPauseTime |
Solo salida. Es la marca de tiempo más reciente en la que se pausó este Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
lastSyncTime |
Solo salida. Solo para los conectores periódicos, es la última vez que se completó una sincronización de datos. Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
updateTime |
Solo salida. Es la marca de tiempo de la última actualización del Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
errors[] |
Solo salida. Son los errores de la inicialización o de la ejecución más reciente del conector. |
syncMode |
Es el modo de sincronización de datos que admite el conector de datos. |
kmsKeyName |
Solo entrada. Es la clave de KMS que se usará para proteger los almacenes de datos administrados por este conector. Se debe configurar para las solicitudes que deben cumplir con las protecciones de la política de la organización de CMEK. Si este campo se configura y procesa correctamente, los almacenes de datos creados por este conector estarán protegidos por la clave de KMS. |
destinationConfigs[] |
Opcional. Son todos los destinos objetivo que se usan para conectarse a servicios de terceros. |
actionState |
Solo salida. Es el estado del conector de acción. Esto refleja si el conector de acción se está inicializando, está activo o si se produjeron errores. |
actionConfig |
Opcional. Son las configuraciones de acciones para que el conector admita acciones. |
endUserConfig |
Opcional. Son los parámetros y las credenciales que se usan específicamente para los conectores de EUA. |
federatedConfig |
Opcional. Son los parámetros y las credenciales que se usan específicamente para los conectores híbridos que admiten el modo FEDERATED. Este campo solo debe configurarse si el conector es híbrido y queremos habilitar el modo FEDERATED. |
connectorModes[] |
Opcional. Son los modos habilitados para este conector. El estado predeterminado es CONNECTOR_MODE_UNSPECIFIED. |
staticIpEnabled |
Opcional. Indica si el cliente habilitó direcciones IP estáticas para este conector. |
staticIpAddresses[] |
Solo salida. Son las direcciones IP estáticas que usa este conector. |
blockingReasons[] |
Solo salida. Son las acciones del usuario que se deben completar antes de que el conector pueda comenzar a sincronizar datos. |
identityRefreshInterval |
Es el intervalo de actualización para sincronizar la información de la lista de control de acceso de los documentos que ingiere este conector. Si no se establece, la lista de control de acceso se actualizará en el intervalo predeterminado de 30 minutos. El intervalo de actualización de la identidad puede ser de al menos 30 minutos y de hasta 7 días. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
identityScheduleConfig |
Es 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 que ingirió este conector. |
privateConnectivityProjectId |
Solo salida. Es el ID del proyecto de usuario asociado con los conectores de conectividad privada. Para que el conector funcione, este proyecto debe estar incluido en la lista de entidades permitidas. |
bapConfig |
Opcional. Es la configuración para establecer una conexión de BAP. |
connectorType |
Solo salida. Es 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 lo establece. |
realtimeState |
Solo salida. Estado de sincronización en tiempo real |
alertPolicyConfigs[] |
Opcional. Es la configuración de alerta a nivel del conector. |
realtimeSyncConfig |
Opcional. Es la configuración de la sincronización en tiempo real. |
aclEnabled |
Opcional. Indica si el conector se creará con una configuración de LCA. Actualmente, este campo solo afecta a los conectores de Cloud Storage y BigQuery. |
createEuaSaas |
Opcional. Indica si el conector de AUTENTICACIÓN DEL USUARIO FINAL se creó en el 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 para este conector. Esto es independiente de autoRunDisabled. Solo se aplica a los conectores de terceros. Cuando el intervalo de actualización se establece en el mismo valor que el intervalo de actualización incremental, se inhabilitará la sincronización incremental, es decir, se establecerá en verdadero. |
incrementalRefreshInterval |
Opcional. Es el intervalo de actualización específico para las sincronizaciones de datos incrementales. Si no se establece, las sincronizaciones incrementales usarán el valor predeterminado del entorno, establecido en 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. Cuando el intervalo de actualización se establece en el mismo valor que el intervalo de actualización incremental, se inhabilitará la sincronización incremental. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
hybridIngestionDisabled |
Opcional. Si el conector es híbrido, determina si la transferencia está habilitada y si se aprovisionan los recursos adecuados durante la creación del conector. Si el conector no es híbrido, se ignora este campo. |
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, es decir,
Ejemplo:
Parámetro opcional para especificar el tipo de autorización que se usará para la compatibilidad con varios tipos de autorización:
|
|
params |
Parámetros obligatorios del conector de datos en formato JSON estructurado. |
jsonParams |
Son los parámetros obligatorios del conector de datos en formato de cadena JSON. |
Estado
Es el estado del conector.
Enums | |
---|---|
STATE_UNSPECIFIED |
Valor predeterminado. |
CREATING |
Se está configurando el conector. |
ACTIVE |
El conector se configuró correctamente y está esperando la próxima ejecución de sincronización. |
FAILED |
El conector tiene un error. Los detalles del error se pueden encontrar en DataConnector.errors . Si el error no se puede corregir, la API de [CollectionService.DeleteCollection] puede borrar el DataConnector . |
RUNNING |
El conector está sincronizando registros de forma activa desde la fuente de datos. |
WARNING |
El conector completó una ejecución de sincronización, pero se encontraron errores recuperables. |
INITIALIZATION_FAILED |
No se pudo 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 para algunos tipos de conectores). |
UPDATING |
El conector está en proceso de actualización. |
SourceEntity
Representa una entidad en la fuente de datos. Por ejemplo, el objeto Account
en Salesforce.
Representación JSON |
---|
{ "entityName": string, "keyPropertyMappings": { string: string, ... }, "dataStore": string, "startingSchema": { object ( |
Campos | |
---|---|
entityName |
Es el nombre de la entidad. Valores admitidos por fuente de datos:
|
keyPropertyMappings |
Son los atributos para la indexación. Clave: Es el nombre del campo. Valor: Es la propiedad clave a la que se asignará un campo, como
|
dataStore |
Solo salida. Es el nombre completo del recurso del almacén de datos asociado para la entidad de origen. Formato: |
startingSchema |
Opcional. Es el esquema de inicio que se usará para el Este campo solo se usa en la API de [SetUpDataConnector][] y se ignorará si se usa en otras APIs. Este campo se omitirá en todas las respuestas de la API, incluida la API de [GetDataConnector][]. Para recuperar el esquema de un El esquema proporcionado se validará según ciertas reglas del esquema. Obtén más información en este documento. |
healthcareFhirConfig |
Opcional. Es la configuración para la vertical de |
Campo de unión
|
|
params |
Son los parámetros de la entidad para facilitar la transferencia de datos en formato JSON estructurado. |
jsonParams |
Son los parámetros de la entidad para facilitar la transferencia de datos en formato de cadena JSON. |
SyncMode
Define el modo de sincronización de datos que admite el conector de datos.
Enums | |
---|---|
PERIODIC |
El conector sincronizará los datos periódicamente según el valor de refreshInterval. Úsalo 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 transfieren datos tendrán este valor. |
DestinationConfig
Define los extremos de destino que se usan para conectarse a fuentes externas.
Representación JSON |
---|
{ "key": string, "destinations": [ { object ( |
Campos | |
---|---|
key |
Opcional. Es el identificador único del destino que admite el conector. |
destinations[] |
Opcional. Son los destinos de la clave correspondiente. |
Campo de unión destination_config_params . Son parámetros adicionales para esta configuración de destino. destination_config_params puede ser solo uno de los siguientes: |
|
params |
Opcional. Son parámetros adicionales para esta configuración de destino en formato JSON estructurado. |
jsonParams |
Son parámetros adicionales para esta configuración de destino en formato de cadena JSON. |
Destino
Define un extremo 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 . Es el destino del extremo. destination puede ser solo uno de los siguientes: |
|
host |
Es un host enrutable públicamente. |
ActionConfig
Es la información para admitir acciones en el conector.
Representación JSON |
---|
{ "isActionConfigured": boolean, "serviceName": string, "useStaticSecrets": boolean, // Union field |
Campos | |
---|---|
isActionConfigured |
Solo salida. El conector contiene los parámetros necesarios y está configurado para admitir acciones. |
serviceName |
Opcional. Es el nombre del recurso del Directorio de servicios (projects/*/locations/*/namespaces/*/services/*) que representa un extremo de red de VPC que se usa para conectarse al Se requiere cuando los Controles del servicio de VPC están habilitados. |
useStaticSecrets |
Opcional. Indica si se deben usar secretos estáticos para el conector. Si es verdadero, 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. Son los parámetros de acción en formato de cadena json. |
EndUserConfig
Son los parámetros y las credenciales que se usan específicamente para los conectores de EUA.
Representación JSON |
---|
{ "additionalParams": { object }, "tenant": { object ( |
Campos | |
---|---|
additionalParams |
Opcional. Son los parámetros adicionales necesarios para EE.UU. |
tenant |
Opcional. Es el proyecto de usuario al que se conecta el conector. |
Campo de unión auth_config . Es la configuración de autenticación para los conectores de la EUA. auth_config puede ser solo uno de los siguientes: |
|
authParams |
Opcional. Son los parámetros de autenticación específicos de los conectores de la EUA. |
jsonAuthParams |
Opcional. Son los parámetros de autenticación específicos de los conectores de la EUA en formato de cadena json. |
Usuario
Es la información del arrendatario para una fuente de conector. Esto incluye parte de la misma información almacenada en el mensaje Credential, pero se limita solo a lo que se necesita para proporcionar una lista de inquilinos accesibles al usuario.
Representación JSON |
---|
{ "id": string, "uri": string, "displayName": string } |
Campos | |
---|---|
id |
Es el ID de la instancia del arrendatario. Ejemplos: Jira (“8594f221-9797-5f78-1fa4-485e198d7cd0”), Slack (“T123456”). |
uri |
Es el URI del arrendatario, si corresponde. Por ejemplo, el URI de una instancia de Jira es https://my-jira-instance.atlassian.net, y un arrendatario de Slack no tiene un URI. |
displayName |
Es el nombre visible opcional del arrendatario, p.ej., "Mi equipo de Slack". |
FederatedConfig
Son los parámetros y las credenciales que se usan específicamente para los conectores híbridos que admiten el modo FEDERATED.
Representación JSON |
---|
{ "additionalParams": { object }, // Union field |
Campos | |
---|---|
additionalParams |
Opcional. Son los parámetros adicionales necesarios para FEDERATED. |
Campo de unión auth_config . Es la configuración de autenticación para los conectores FEDERATED. auth_config puede ser solo uno de los siguientes: |
|
authParams |
Opcional. Son los parámetros de autenticación específicos de los conectores FEDERATED. |
jsonAuthParams |
Opcional. Son los parámetros de autenticación específicos de los conectores FEDERATED en formato de cadena json. |
ConnectorMode
Son los modos habilitados para este conector. INGESTION, ACTIONS, FEDERATED, OR EUA
Enums | |
---|---|
CONNECTOR_MODE_UNSPECIFIED |
No se especificó el modo del conector. |
DATA_INGESTION |
Es el conector que se utiliza para la transferencia de datos. |
ACTIONS |
Es el conector que se utiliza para las acciones. |
FEDERATED |
Es el conector que se utiliza para la búsqueda federada. |
EUA |
Es el conector que se utiliza para la autenticación del usuario final. |
FEDERATED_AND_EUA |
Es un conector híbrido que se utiliza para la búsqueda federada y la autenticación de usuarios finales. |
BlockingReason
Son las acciones del usuario que se deben completar antes de que el conector pueda comenzar a sincronizar datos.
Enums | |
---|---|
BLOCKING_REASON_UNSPECIFIED |
Valor predeterminado. |
ALLOWLIST_STATIC_IP |
El conector requiere que el cliente incluya las IPs estáticas en la lista de entidades permitidas. |
ALLOWLIST_IN_SERVICE_ATTACHMENT |
El conector requiere que el cliente incluya nuestro proyecto en la lista de entidades permitidas de su adjunto de servicio. |
ALLOWLIST_SERVICE_ACCOUNT |
El conector requiere que el cliente incluya la cuenta de servicio en la lista de anunciantes permitidos de su proyecto. |
IdentityScheduleConfig
Es la configuración de las ejecuciones de sincronización de datos de identidad.
Representación JSON |
---|
{
"refreshInterval": string,
"nextSyncTime": {
object ( |
Campos | |
---|---|
refreshInterval |
Opcional. Es el intervalo de actualización para sincronizar la información de la lista de control de acceso de los documentos que ingiere este conector. Si no se establece, la lista de control de acceso se actualizará en el intervalo predeterminado de 30 minutos. El intervalo de actualización de la identidad puede ser de al menos 30 minutos y de hasta 7 días. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
nextSyncTime |
Opcional. Es la fecha y hora en UTC en la que se espera que comience la próxima sincronización de datos para el conector de datos. Los clientes solo pueden especificar la hora y el minuto 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
Es la configuración del conector de BAP.
Representación JSON |
---|
{
"supportedConnectorModes": [
enum ( |
Campos | |
---|---|
supportedConnectorModes[] |
Obligatorio. Son los modos de conector admitidos para la conexión BAP asociada. |
enabledActions[] |
Opcional. Son las acciones habilitadas en la conexión de la BAP asociada. |
ConnectorMode
Son los casos de uso que admite este conector de la BAP.
Enums | |
---|---|
CONNECTOR_MODE_UNSPECIFIED |
No se especificó el modo del conector. |
DATA_INGESTION |
Es el conector que se utiliza para la transferencia de datos. |
ACTIONS |
Conector utilizado para las acciones |
END_USER_AUTHENTICATION |
Es el conector que se utiliza para la autenticación del usuario final. |
ConnectorType
Es el tipo de conector.
Enums | |
---|---|
CONNECTOR_TYPE_UNSPECIFIED |
Valor predeterminado. |
THIRD_PARTY |
Conector de terceros a conector a aplicación de terceros. |
GCP_FHIR |
El conector de datos se conecta entre el almacén de FHIR y el almacén de datos de VAIS. |
BIG_QUERY |
Es un conector de BigQuery. |
GCS |
Es el conector de Google Cloud Storage. |
GOOGLE_MAIL |
Conector de Gmail. |
GOOGLE_CALENDAR |
Es un conector del Calendario de Google. |
GOOGLE_DRIVE |
Es el conector de Google Drive. |
NATIVE_CLOUD_IDENTITY |
Conector nativo de Cloud Identity para la búsqueda de personas con tecnología de la API de People. |
THIRD_PARTY_FEDERATED |
Es un conector federado, es decir, un conector de terceros que no ingiere datos y cuya búsqueda se basa en la API de la aplicación de terceros. |
THIRD_PARTY_EUA |
Es el conector que se utiliza para las funciones de autenticación de usuarios finales. |
GCNV |
Es el conector de Google Cloud NetApp Volumes. |
AlertPolicyConfig
Es la configuración de alerta a nivel del conector.
Representación JSON |
---|
{
"alertPolicyName": string,
"alertEnrollments": [
{
object ( |
Campos | |
---|---|
alertPolicyName |
Inmutable. Es el nombre del recurso AlertPolicy completamente calificado. |
alertEnrollments[] |
Opcional. Son los estados de inscripción de cada alerta. |
AlertEnrollment
Es el estado de inscripción de la alerta.
Representación JSON |
---|
{
"alertId": string,
"enrollState": enum ( |
Campos | |
---|---|
alertId |
Inmutable. Es el ID de una alerta. |
enrollState |
Obligatorio. Es el estado de inscripción de un cliente. |
EnrollStates
Es la enumeración del estado de inscripción de la alerta.
Enums | |
---|---|
ENROLL_STATES_UNSPECIFIED |
Valor predeterminado. Se usa para los clientes que no respondieron a la política de alertas. |
ENROLLED |
El cliente está inscrito en esta política. |
DECLINED |
El cliente rechazó esta política. |
RealtimeSyncConfig
Es la configuración de la sincronización en tiempo real para almacenar parámetros adicionales para la sincronización en tiempo real.
Representación JSON |
---|
{
"webhookUri": string,
"realtimeSyncSecret": string,
"streamingError": {
object ( |
Campos | |
---|---|
webhookUri |
Opcional. Es la URL de webhook para que el conector especifique parámetros adicionales para la sincronización en tiempo real. |
realtimeSyncSecret |
Opcional. Es el ID del secreto de Secret Manager que se usa para el secreto del webhook. |
streamingError |
Opcional. Son los detalles del error de transmisión. |
StreamingError
Son los detalles del error de transmisión.
Representación JSON |
---|
{ "streamingErrorReason": enum ( |
Campos | |
---|---|
streamingErrorReason |
Opcional. Error de transmisión. |
error |
Opcional. Son los detalles del error. |
StreamingErrorReason
Son tipos generales de errores de transmisión.
Enums | |
---|---|
STREAMING_ERROR_REASON_UNSPECIFIED |
No se especificó el motivo del error de transmisión. |
STREAMING_SETUP_ERROR |
Se produjo un error al configurar los recursos para la sincronización en tiempo real. |
STREAMING_SYNC_ERROR |
Se produjo un error durante la ejecución de la sincronización en tiempo real para el conector. |
INGRESS_ENDPOINT_REQUIRED |
El extremo de entrada es obligatorio cuando se configura la sincronización en tiempo real en la conectividad privada. |