DataConnector

Gère la connexion aux sources de données externes pour tous les magasins de données regroupés sous un Collection. Il s'agit d'une ressource singleton de Collection. L'initialisation n'est prise en charge que par la méthode DataConnectorService.SetUpDataConnector, qui crée un Collection et initialise son DataConnector.

Représentation 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.
}
Champs
name

string

Uniquement en sortie. Nom complet de la ressource du connecteur de données. Format : projects/*/locations/*/collections/*/dataConnector.
state

enum (State)

Uniquement en sortie. État du connecteur.
dataSource

string

Obligatoire. Nom de la source de données. Valeurs autorisées : salesforce, jira, confluence, bigquery.
removeParamKeys[]

string

Facultatif. Spécifie les clés à supprimer du champ "params". Cette option n'est active que lorsque "params" est inclus dans "updateMask" dans une requête UpdateDataConnectorRequest. La suppression est prioritaire si une clé figure à la fois dans "removeParamKeys" et dans le champ "params" de la requête.
refreshInterval

string (Duration format)

Obligatoire. Intervalle d'actualisation pour la synchronisation des données. Si la durée est définie sur 0, les données sont synchronisées en temps réel. La fonctionnalité de streaming n'est pas encore disponible. La durée minimale est de 30 minutes et la durée maximale de sept jours. Si l'intervalle d'actualisation est défini sur la même valeur que l'intervalle d'actualisation incrémentielle, la synchronisation incrémentielle sera désactivée.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
nextSyncTime

object (DateTime)

Définit l'heure planifiée de la prochaine synchronisation des données. Ce champ nécessite l'heure, la minute et le fuseau horaire de la base de données des fuseaux horaires IANA. Cette option est utilisée lorsque le connecteur de données a un intervalle d'actualisation supérieur à un jour. Si les heures ou les minutes ne sont pas spécifiées, nous considérerons que l'heure de synchronisation est 0:00. L'utilisateur doit fournir un fuseau horaire pour éviter toute ambiguïté.
entities[]

object (SourceEntity)

Liste des entités de la source de données connectée à ingérer.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de création de DataConnector.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
latestPauseTime

string (Timestamp format)

Uniquement en sortie. Code temporel le plus récent auquel cette DataConnector a été suspendue, ce qui affecte toutes les fonctionnalités telles que la synchronisation des données. Voici ce qui se produit si vous suspendez un connecteur : - Toutes les fonctionnalités, y compris la synchronisation des données, sont interrompues.  Tout job de synchronisation de données en cours sera annulé.  Aucune synchronisation de données future ne sera planifiée ni déclenchée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
lastSyncTime

string (Timestamp format)

Uniquement en sortie. Pour les connecteurs périodiques uniquement, il s'agit de la dernière fois qu'une synchronisation des données a été effectuée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de DataConnector.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
errors[]

object (Status)

Uniquement en sortie. Erreurs d'initialisation ou de la dernière exécution du connecteur.
syncMode

enum (SyncMode)

Mode de synchronisation des données compatible avec le connecteur de données.
kmsKeyName

string

Uniquement en entrée. Clé KMS à utiliser pour protéger les DataStores gérés par ce connecteur.

Doit être défini pour les requêtes qui doivent respecter les protections des règles d'administration CMEK.

Si ce champ est défini et traité correctement, les DataStores créés par ce connecteur seront protégés par la clé KMS.
destinationConfigs[]

object (DestinationConfig)

Facultatif. Toutes les destinations cibles utilisées pour se connecter à des services tiers.
actionState

enum (State)

Uniquement en sortie. État du connecteur d'action. Cela indique si le connecteur d'action est en cours d'initialisation, actif ou a rencontré des erreurs.
actionConfig

object (ActionConfig)

Facultatif. Configurez les actions pour que le connecteur les prenne en charge.
endUserConfig

object (EndUserConfig)

Facultatif. Tous les paramètres et identifiants utilisés spécifiquement pour les connecteurs EULA.
federatedConfig

object (FederatedConfig)

Facultatif. Tous les paramètres et identifiants utilisés spécifiquement pour les connecteurs hybrides compatibles avec le mode FEDERATED. Ce champ ne doit être défini que si le connecteur est un connecteur hybride et que nous souhaitons activer le mode FÉDÉRÉ.
connectorModes[]

enum (ConnectorMode)

Facultatif. Modes activés pour ce connecteur. L'état par défaut est CONNECTOR_MODE_UNSPECIFIED.
staticIpEnabled

boolean

Facultatif. Indique si le client a activé les adresses IP statiques pour ce connecteur.
staticIpAddresses[]

string

Uniquement en sortie. Adresses IP statiques utilisées par ce connecteur.
blockingReasons[]

enum (BlockingReason)

Uniquement en sortie. Actions utilisateur qui doivent être effectuées avant que le connecteur puisse commencer à synchroniser les données.
identityRefreshInterval
(deprecated)

string (Duration format)

Intervalle d'actualisation pour synchroniser les informations de la liste de contrôle d'accès pour les documents ingérés par ce connecteur. Si cette règle n'est pas configurée, la liste de contrôle des accès sera actualisée à l'intervalle par défaut de 30 minutes. L'intervalle d'actualisation de l'identité peut être d'au moins 30 minutes et d'au plus 7 jours.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
identityScheduleConfig

object (IdentityScheduleConfig)

Configuration des exécutions de synchronisation des données d'identité. Il contient l'intervalle d'actualisation pour synchroniser les informations de la liste de contrôle d'accès des documents ingérés par ce connecteur.
privateConnectivityProjectId

string

Uniquement en sortie. ID du projet locataire associé aux connecteurs de connectivité privée. Ce projet doit être ajouté à la liste d'autorisation pour que le connecteur fonctionne.
bapConfig

object (BAPConfig)

Facultatif. Configuration permettant d'établir une connexion BAP.
connectorType

enum (ConnectorType)

Uniquement en sortie. Type de connecteur. Chaque source ne peut être associée qu'à un seul type. Par exemple, salesforce, confluence et jira ont le type de connecteur THIRD_PARTY. Une fois défini par le système, il ne peut plus être modifié.
realtimeState

enum (State)

Uniquement en sortie. État de la synchronisation en temps réel
alertPolicyConfigs[]

object (AlertPolicyConfig)

Facultatif. Configuration des alertes au niveau du connecteur.
realtimeSyncConfig

object (RealtimeSyncConfig)

Facultatif. Configuration de la synchronisation en temps réel.
aclEnabled

boolean

Facultatif. Indique si le connecteur sera créé avec une configuration de LCA. Actuellement, ce champ ne concerne que les connecteurs Cloud Storage et BigQuery.
createEuaSaas

boolean

Facultatif. Indique si le connecteur END USER AUTHENTICATION est créé dans SaaS.
autoRunDisabled

boolean

Facultatif. Indique si le connecteur est désactivé pour l'exécution automatique. Elle peut être utilisée pour suspendre la synchronisation périodique et en temps réel. Mise à jour : avec l'introduction de incrementalSyncDisabled, autoRunDisabled est utilisé pour suspendre/désactiver uniquement les synchronisations complètes.
incrementalSyncDisabled

boolean

Facultatif. Indique si les synchronisations incrémentielles sont suspendues pour ce connecteur. Cela est indépendant de autoRunDisabled. Applicable uniquement aux connecteurs tiers. Lorsque l'intervalle d'actualisation est défini sur la même valeur que l'intervalle d'actualisation incrémentielle, la synchronisation incrémentielle est désactivée (c'est-à-dire définie sur "true").
incrementalRefreshInterval

string (Duration format)

Facultatif. Intervalle d'actualisation spécifique aux synchronisations incrémentielles des données. Si elle n'est pas définie, les synchronisations incrémentielles utiliseront la valeur par défaut de l'environnement, qui est de trois heures. La durée minimale est de 30 minutes et la durée maximale de sept jours. Applicable uniquement aux connecteurs tiers. Si l'intervalle d'actualisation est défini sur la même valeur que l'intervalle d'actualisation incrémentielle, la synchronisation incrémentielle sera désactivée.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
hybridIngestionDisabled

boolean

Facultatif. Si le connecteur est un connecteur hybride, détermine si l'ingestion est activée et si les ressources appropriées sont provisionnées lors de la création du connecteur. Si le connecteur n'est pas un connecteur hybride, ce champ est ignoré.

Champ d'union data_connector_params. Paramètres nécessaires pour accéder à la source au format de paires (clé, valeur). Les valeurs de chaîne au format projects/*/[locations/*/]secrets/*/versions/* seront lues à partir de Secret Manager.

Paramètres requis pour toutes les sources de données :

  • Clé : instance_uri
  • Valeur : type STRING. URI permettant d'accéder à la source de données.

Paramètres requis pour les sources compatibles avec OAUTH, c'est-à-dire salesforce :

  • Clé : client_id
  • Valeur : type STRING. ID client du fournisseur de services tiers permettant d'identifier votre application.
  • Clé : client_secret
  • Valeur : type STRING. Code secret du client généré par le serveur d'autorisation tiers.
  • Clé : access_token
  • Valeur : type STRING. Jeton OAuth permettant à UCS d'accéder à la ressource protégée.
  • Clé : refresh_token
  • Valeur : type STRING. Jeton d'actualisation OAuth pour que UCS obtienne un nouveau jeton d'accès sans interaction de l'utilisateur.

Paramètres requis pour les sources qui acceptent l'authentification de base par jeton d'API, c'est-à-dire jira et confluence :

  • Clé : user_account
  • Valeur : type STRING. Nom d'utilisateur ou adresse e-mail de la source.
  • Clé : api_token
  • Valeur : type STRING. Jeton d'API généré pour le compte source, utilisé pour l'authentification partout où vous auriez utilisé un mot de passe.

Exemple :

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

Paramètre facultatif permettant de spécifier le type d'autorisation à utiliser pour la prise en charge de plusieurs types d'autorisation :

  • Clé : auth_type
  • Valeur : type STRING. Type d'autorisation pour la source de données. Valeurs acceptées : BASIC_AUTH, OAUTH, OAUTH_ACCESS_TOKEN, OAUTH_TWO_LEGGED, OAUTH_JWT_BEARER, OAUTH_PASSWORD_GRANT, JWT, API_TOKEN, FEDERATED_CREDENTIAL. data_connector_params ne peut être qu'un des éléments suivants :
params

object (Struct format)

Paramètres requis du connecteur de données au format JSON structuré.
jsonParams

string

Paramètres requis du connecteur de données au format chaîne JSON.

État

État du connecteur.

Enums
STATE_UNSPECIFIED Valeur par défaut.
CREATING Le connecteur est en cours de configuration.
ACTIVE Le connecteur a bien été configuré et attend la prochaine synchronisation.
FAILED Le connecteur est en erreur. Vous trouverez les détails de l'erreur dans DataConnector.errors. Si l'erreur est impossible à corriger, le DataConnector peut être supprimé par l'API [CollectionService.DeleteCollection].
RUNNING Le connecteur synchronise activement les enregistrements de la source de données.
WARNING Le connecteur a fini d'exécuter une synchronisation, mais des erreurs non fatales ont été détectées.
INITIALIZATION_FAILED Échec de l'initialisation du connecteur. Les causes potentielles incluent des erreurs d'exécution ou des problèmes dans le pipeline asynchrone, qui empêchent la requête d'atteindre les services en aval (à l'exception de certains types de connecteurs).
UPDATING Le connecteur est en cours de mise à jour.

SourceEntity

Représente une entité dans la source de données. Par exemple, l'objet Account dans Salesforce.

Représentation 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.
}
Champs
entityName

string

Nom de l'entité. Valeurs acceptées par source de données :

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

map (key: string, value: string)

Attributs pour l'indexation. Clé : nom du champ. Valeur : propriété clé à laquelle mapper un champ, par exemple title et description. Propriétés de clé acceptées :

  • title : titre de l'enregistrement de données. Il s'affichera dans les résultats de recherche.
  • description : description de l'enregistrement de données. Il s'affichera dans les résultats de recherche.
dataStore

string

Uniquement en sortie. Nom complet de la ressource du data store associé pour l'entité source. Format : projects/*/locations/*/collections/*/dataStores/*. Lorsque le connecteur est initialisé par la méthode DataConnectorService.SetUpDataConnector, un DataStore est automatiquement créé pour chaque entité source.
startingSchema

object (Schema)

Facultatif. Schéma de début à utiliser pour le DataStore créé à partir de cette SourceEntity. Si cette option n'est pas définie, un schéma vertical spécialisé par défaut sera utilisé.

Ce champ n'est utilisé que par l'API [SetUpDataConnector][] et sera ignoré s'il est utilisé dans d'autres API. Ce champ sera omis de toutes les réponses d'API, y compris l'API [GetDataConnector][]. Pour récupérer le schéma d'un DataStore, utilisez plutôt l'API SchemaService.GetSchema.

Le schéma fourni sera validé par rapport à certaines règles. Pour en savoir plus, consultez ce document.
healthcareFhirConfig

object (HealthcareFhirConfig)

Facultatif. Configuration pour le secteur HEALTHCARE_FHIR.

Champ d'union entity_params. Paramètres de l'entité pour faciliter l'ingestion de données. Par exemple, pour les connecteurs BigQuery :

  • Clé : document_id_column
  • Valeur : type STRING. Valeur de l'ID de colonne. entity_params ne peut être qu'un des éléments suivants :
params

object (Struct format)

Paramètres de l'entité pour faciliter l'ingestion de données au format JSON structuré.
jsonParams

string

Paramètres de l'entité pour faciliter l'ingestion de données au format JSON.

SyncMode

Définit le mode de synchronisation des données accepté par le connecteur de données.

Enums
PERIODIC Le connecteur synchronise les données périodiquement en fonction de refreshInterval. Utilisez-le avec autoRunDisabled pour suspendre la synchronisation périodique ou indiquer une synchronisation ponctuelle.
STREAMING Les données seront synchronisées en temps réel.
UNSPECIFIED Cette valeur s'affiche pour les connecteurs qui n'ingèrent pas de données.

DestinationConfig

Définit les points de terminaison cibles utilisés pour se connecter à des sources tierces.

Représentation 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.
}
Champs
key

string

Facultatif. Identifiant unique de destination compatible avec le connecteur.
destinations[]

object (Destination)

Facultatif. Destinations de la clé correspondante.
Champ d'union destination_config_params. Paramètres supplémentaires pour cette configuration de destination. destination_config_params ne peut être qu'un des éléments suivants :
params

object (Struct format)

Facultatif. Paramètres supplémentaires pour cette configuration de destination au format JSON structuré.
jsonParams

string

Paramètres supplémentaires pour cette configuration de destination au format JSON.

Destination

Définit un point de terminaison cible

Représentation 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.
}
Champs
port

integer

Facultatif. Numéro de port cible accepté par la destination.
Champ d'union destination. Destination du point de terminaison. destination ne peut être qu'un des éléments suivants :
host

string

Hôte routable publiquement.

ActionConfig

Informations permettant d'effectuer des actions sur le connecteur.

Représentation 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.
}
Champs
isActionConfigured

boolean

Uniquement en sortie. Le connecteur contient les paramètres nécessaires et est configuré pour prendre en charge les actions.
serviceName

string

Facultatif. Nom de ressource Service Directory (projects/*/locations/*/namespaces/*/services/*) représentant un point de terminaison de réseau VPC utilisé pour se connecter à instance_uri de la source de données, défini dans DataConnector.params.

Obligatoire lorsque VPC Service Controls est activé.
useStaticSecrets

boolean

Facultatif. Indique si des secrets statiques doivent être utilisés pour le connecteur. Si la valeur est "true", les secrets fournis dans actionParams seront ignorés.

Champ d'union action_config_params. Paramètres nécessaires pour prendre en charge les actions au format de paires (clé, valeur). Les valeurs de chaîne au format projects/*/[locations/*/]secrets/*/versions/* seront lues à partir de Secret Manager.

Paramètres requis pour les sources compatibles avec OAUTH, c'est-à-dire gmail, google_calendar, jira, workday, salesforce, confluence :

  • Clé : client_id
  • Valeur : type STRING. ID client du fournisseur de services permettant d'identifier votre application.
  • Clé : client_secret
  • Valeur : type STRING. Code secret du client généré par le serveur d'autorisation de l'application. action_config_params ne peut être qu'un des éléments suivants :
actionParams

object (Struct format)

Facultatif. Paramètres d'action au format JSON structuré.
jsonActionParams

string

Facultatif. Paramètres d'action au format de chaîne JSON.

EndUserConfig

Tous les paramètres et identifiants utilisés spécifiquement pour les connecteurs EULA.

Représentation 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.
}
Champs
additionalParams

object (Struct format)

Facultatif. Tous les paramètres supplémentaires nécessaires pour l'EUA.
tenant

object (Tenant)

Facultatif. Projet locataire auquel le connecteur est associé.
Champ d'union auth_config. Configuration de l'authentification pour les connecteurs d'EUA. auth_config ne peut être qu'un des éléments suivants :
authParams

object (Struct format)

Facultatif. Tous les paramètres d'authentification spécifiques aux connecteurs EUA.
jsonAuthParams

string

Facultatif. Tous les paramètres d'authentification spécifiques aux connecteurs EUA au format chaîne JSON.

Locataire

Informations sur le locataire pour une source de connecteur. Cela inclut certaines des informations stockées dans le message d'identifiant, mais se limite à ce qui est nécessaire pour fournir à l'utilisateur une liste des locataires accessibles.

Représentation JSON 
{
  "id": string,
  "uri": string,
  "displayName": string
}
Champs
id

string

ID de l'instance du locataire. Exemples : Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").
uri

string

URI du locataire, le cas échéant. Par exemple, l'URI d'une instance Jira est https://my-jira-instance.atlassian.net, et un locataire Slack n'a pas d'URI.
displayName

string

Nom à afficher facultatif pour le locataire, par exemple "Mon équipe Slack".

FederatedConfig

Tous les paramètres et identifiants utilisés spécifiquement pour les connecteurs hybrides compatibles avec le mode FEDERATED.

Représentation 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.
}
Champs
additionalParams

object (Struct format)

Facultatif. Tous les paramètres supplémentaires nécessaires pour FEDERATED.
Champ d'union auth_config. Configuration de l'authentification pour les connecteurs FEDERATED. auth_config ne peut être qu'un des éléments suivants :
authParams

object (Struct format)

Facultatif. Tous les paramètres d'authentification spécifiques aux connecteurs FÉDÉRÉS.
jsonAuthParams

string

Facultatif. Tous les paramètres d'authentification spécifiques aux connecteurs FEDERATED au format de chaîne JSON.

ConnectorMode

Modes activés pour ce connecteur. INGESTION, ACTIONS, FEDERATED, OR EUA

Enums
CONNECTOR_MODE_UNSPECIFIED Mode du connecteur non spécifié.
DATA_INGESTION Connecteur utilisé pour l'ingestion de données.
ACTIONS Connecteur utilisé pour les actions.
FEDERATED Connecteur utilisé pour la recherche fédérée.
EUA Connecteur utilisé pour l'authentification des utilisateurs finaux.
FEDERATED_AND_EUA Connecteur hybride utilisé pour la recherche fédérée et l'authentification des utilisateurs finaux.

BlockingReason

Actions utilisateur qui doivent être effectuées avant que le connecteur puisse commencer à synchroniser les données.

Enums
BLOCKING_REASON_UNSPECIFIED Valeur par défaut.
ALLOWLIST_STATIC_IP Le connecteur exige que le client ajoute des adresses IP statiques à la liste d'autorisation.
ALLOWLIST_IN_SERVICE_ATTACHMENT Le connecteur exige que le client ajoute notre projet à la liste d'autorisation dans son rattachement de service.
ALLOWLIST_SERVICE_ACCOUNT Le connecteur exige que le client ajoute le compte de service à la liste d'autorisation de son projet.

IdentityScheduleConfig

Configuration des exécutions de synchronisation des données d'identité.

Représentation JSON 
{
  "refreshInterval": string,
  "nextSyncTime": {
    object (DateTime)
  }
}
Champs
refreshInterval

string (Duration format)

Facultatif. Intervalle d'actualisation pour synchroniser les informations de la liste de contrôle d'accès pour les documents ingérés par ce connecteur. Si cette règle n'est pas configurée, la liste de contrôle des accès sera actualisée à l'intervalle par défaut de 30 minutes. L'intervalle d'actualisation de l'identité peut être d'au moins 30 minutes et d'au plus 7 jours.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
nextSyncTime

object (DateTime)

Facultatif. Heure UTC à laquelle la prochaine synchronisation des données est censée démarrer pour le connecteur de données. Les clients ne peuvent spécifier que l'heure et la minute pour planifier la synchronisation des données. Cette option est utilisée lorsque le connecteur de données a un intervalle d'actualisation supérieur à un jour.

BAPConfig

Configuration du connecteur BAP.

Représentation JSON 
{
  "supportedConnectorModes": [
    enum (ConnectorMode)
  ],
  "enabledActions": [
    string
  ]
}
Champs
supportedConnectorModes[]

enum (ConnectorMode)

Obligatoire. Modes de connecteur compatibles pour la connexion BAP associée.
enabledActions[]

string

Facultatif. Actions activées sur la connexion BAP associée.

ConnectorMode

Cas d'utilisation compatibles avec ce connecteur BAP.

Enums
CONNECTOR_MODE_UNSPECIFIED Mode du connecteur non spécifié.
DATA_INGESTION Connecteur utilisé pour l'ingestion de données.
ACTIONS Connecteur utilisé pour les actions
END_USER_AUTHENTICATION Connecteur utilisé pour l'authentification des utilisateurs finaux.

ConnectorType

Type de connecteur.

Enums
CONNECTOR_TYPE_UNSPECIFIED Valeur par défaut.
THIRD_PARTY Connecteur tiers vers une application tierce.
GCP_FHIR Le connecteur de données établit la connexion entre le magasin FHIR et le data store VAIS.
BIG_QUERY Connecteur BigQuery.
GCS Connecteur Google Cloud Storage.
GOOGLE_MAIL Connecteur Gmail.
GOOGLE_CALENDAR Connecteur Google Agenda.
GOOGLE_DRIVE Connecteur Google Drive.
NATIVE_CLOUD_IDENTITY Connecteur Cloud Identity natif pour la recherche de personnes, optimisé par l'API People.
THIRD_PARTY_FEDERATED Connecteur fédéré : il s'agit d'un connecteur tiers qui n'ingère pas de données. La recherche est optimisée par l'API de l'application tierce.
THIRD_PARTY_EUA Connecteur utilisé pour les fonctionnalités d'authentification des utilisateurs finaux.
GCNV Connecteur Google Cloud NetApp Volumes.

AlertPolicyConfig

Configuration des alertes au niveau du connecteur.

Représentation JSON 
{
  "alertPolicyName": string,
  "alertEnrollments": [
    {
      object (AlertEnrollment)
    }
  ]
}
Champs
alertPolicyName

string

Immuable. Nom complet de la ressource AlertPolicy.
alertEnrollments[]

object (AlertEnrollment)

Facultatif. États d'inscription de chaque alerte.

AlertEnrollment

État de l'inscription à l'alerte.

Représentation JSON 
{
  "alertId": string,
  "enrollState": enum (EnrollStates)
}
Champs
alertId

string

Immuable. ID d'une alerte.
enrollState

enum (EnrollStates)

Obligatoire. État d'inscription d'un client.

EnrollStates

Énumération de l'état de l'inscription pour l'alerte.

Enums
ENROLL_STATES_UNSPECIFIED Valeur par défaut. Utilisé pour les clients qui n'ont pas répondu au règlement sur les alertes.
ENROLLED Le client est inscrit à ce règlement.
DECLINED Le client a refusé cette règle.

RealtimeSyncConfig

Configuration de la synchronisation en temps réel pour stocker des paramètres supplémentaires.

Représentation JSON 
{
  "webhookUri": string,
  "realtimeSyncSecret": string,
  "streamingError": {
    object (StreamingError)
  }
}
Champs
webhookUri

string

Facultatif. URL du webhook permettant au connecteur de spécifier des paramètres supplémentaires pour la synchronisation en temps réel.
realtimeSyncSecret

string

Facultatif. ID du secret Secret Manager utilisé pour le secret du webhook.
streamingError

object (StreamingError)

Facultatif. Détails de l'erreur de streaming.

StreamingError

Détails de l'erreur de streaming.

Représentation JSON 
{
  "streamingErrorReason": enum (StreamingErrorReason),
  "error": {
    object (Status)
  }
}
Champs
streamingErrorReason

enum (StreamingErrorReason)

Facultatif. Erreur de streaming.
error

object (Status)

Facultatif. Détails de l'erreur.

StreamingErrorReason

Types généraux d'erreurs de streaming.

Enums
STREAMING_ERROR_REASON_UNSPECIFIED Le motif de l'erreur de streaming n'est pas spécifié.
STREAMING_SETUP_ERROR Une erreur s'est produite lors de la configuration des ressources pour la synchronisation en temps réel.
STREAMING_SYNC_ERROR Une erreur s'est produite lors de l'exécution de la synchronisation en temps réel pour le connecteur.
INGRESS_ENDPOINT_REQUIRED Un point de terminaison d'Ingress est requis lorsque vous configurez la synchronisation en temps réel dans une connectivité privée.