io.enterpriseai.resources.ConnectorsClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/ConnectorsClient.java. Retour à l'index de la référence du SDK Java.
Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.
Classe ConnectorsClient
Connecteurs. Connector Hub : registre des connexions aux systèmes externes (applications SaaS, API, sources de données), leurs identifiants conservés côté serveur, les exécutions de synchronisation, le Credential Broker qui remet des baux de courte durée à la place des secrets, et la Webhook Gateway qui reçoit les événements signés des fournisseurs.
Constructeur ConnectorsClient
ConnectorsClient(Transport transport)
Crée le client sur le transport partagé ; EnterpriseAIClient le construit, on y accède par l'accesseur du même nom.
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
transport | Transport | oui | Transport partagé par les sous-clients d'un même client. |
ConnectorsClient.create
JsonNode create(Object body)
Enregistrer un connecteur. Applique un manifeste Connector : crée ou met à jour le connecteur (apply_status : created ou updated). Les URL doivent être permises par la politique de sortie réseau ; OAuth2 demande auth.token_url ; les webhooks non signés sont refusés (422 invalid_manifest). Demande tenant_admin, developer ou application_owner. Audité sous connector.apply.
Route : /v1/connectors (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Manifeste Connector (kind: Connector, metadata, spec avec URL de base, auth, ressources, scopes, synchronisation et webhooks). |
Retour : JsonNode. Réponse JSON décodée de l'opération « Enregistrer un connecteur ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ConnectorsClient.create
JsonNode create(Object body, RequestOptions options)
Enregistrer un connecteur. Applique un manifeste Connector : crée ou met à jour le connecteur (apply_status : created ou updated). Les URL doivent être permises par la politique de sortie réseau ; OAuth2 demande auth.token_url ; les webhooks non signés sont refusés (422 invalid_manifest). Demande tenant_admin, developer ou application_owner. Audité sous connector.apply.
Route : /v1/connectors (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Manifeste Connector (kind: Connector, metadata, spec avec URL de base, auth, ressources, scopes, synchronisation et webhooks). | |
options | RequestOptions | oui | Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation). |
Retour : JsonNode. Réponse JSON décodée de l'opération « Enregistrer un connecteur ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ConnectorsClient.delete
void delete(String name)
Supprimer un connecteur. Supprime le connecteur et ses identifiants dans le magasin de secrets. Demande tenant_admin. 404 connector_not_found. Audité sous connector.delete.
Route : /v1/connectors/{name} (DELETE).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom du connecteur. |
Retour : void.
Erreurs levées : les erreurs typées du transport (Erreurs).
ConnectorsClient.get
JsonNode get(String name)
Lire un connecteur. Renvoie le connecteur avec son manifeste, son statut, son propriétaire et ses identifiants configurés (type, noms de champs, date de mise à jour). 404 connector_not_found.
Route : /v1/connectors/{name} (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom du connecteur. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Lire un connecteur ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ConnectorsClient.list
Page<JsonNode> list()
Lister les connecteurs. Connecteurs du tenant dans l'ordre des noms, chacun avec les types d'identifiants configurés (jamais leurs valeurs). Une seule page.
Route : /v1/connectors (GET).
Cet élément ne prend aucun paramètre.
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les connecteurs ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ConnectorsClient.setCredentials
JsonNode setCredentials(String name, Object body)
Enregistrer les identifiants d'un connecteur. Enregistre des identifiants dans le magasin de secrets et ne renvoie que le type et les noms de champs (201). Demande tenant_admin ou security_officer. Corps : kind plus ses champs : - oauth2_client : client_id, client_secret ; - oauth2_code : code, redirect_uri, code_verifier facultatif ; le code est échangé aussitôt auprès de l'URL de jeton (demande un oauth2_client enregistré, sinon 409 credential_unavailable) et conservé comme oauth2_token ; - api_key : api_key, header facultatif ; - service_account : private_key ou token, client_email et client_id facultatifs ; - basic : username, password ; - webhook_secret : secret. Un type inconnu ou des champs manquants répondent 400 invalid_request. Audité sous connector.credentials.write.
Route : /v1/connectors/{name}/credentials (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom du connecteur. | |
body | Object | oui | Type d'identifiant et ses champs. En écriture seule : les valeurs ne sont jamais renvoyées. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Enregistrer les identifiants d'un connecteur ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ConnectorsClient.setCredentials
JsonNode setCredentials(String name, Object body, RequestOptions options)
Enregistrer les identifiants d'un connecteur. Enregistre des identifiants dans le magasin de secrets et ne renvoie que le type et les noms de champs (201). Demande tenant_admin ou security_officer. Corps : kind plus ses champs : - oauth2_client : client_id, client_secret ; - oauth2_code : code, redirect_uri, code_verifier facultatif ; le code est échangé aussitôt auprès de l'URL de jeton (demande un oauth2_client enregistré, sinon 409 credential_unavailable) et conservé comme oauth2_token ; - api_key : api_key, header facultatif ; - service_account : private_key ou token, client_email et client_id facultatifs ; - basic : username, password ; - webhook_secret : secret. Un type inconnu ou des champs manquants répondent 400 invalid_request. Audité sous connector.credentials.write.
Route : /v1/connectors/{name}/credentials (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom du connecteur. | |
body | Object | oui | Type d'identifiant et ses champs. En écriture seule : les valeurs ne sont jamais renvoyées. | |
options | RequestOptions | oui | Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation). |
Retour : JsonNode. Réponse JSON décodée de l'opération « Enregistrer les identifiants d'un connecteur ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ConnectorsClient.sync
JsonNode sync(String name)
Lancer une synchronisation. Met en file une synchronisation (202) et publie connectors.<nom>.sync pour le worker. Le manifeste doit déclarer un mode de synchronisation (409 sync_disabled), le connecteur doit être actif (409 connector_disabled), les ressources doivent être lisibles (400 invalid_request) et aucune autre exécution ne doit être en file ou en cours (409 sync_in_progress). Une synchronisation incrémentale part du curseur de la dernière exécution réussie sauf avec full. La politique connector.sync est évaluée. Demande tenant_admin, developer ou agent. Audité sous connector.sync.
Route : /v1/connectors/{name}/sync (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom du connecteur. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Lancer une synchronisation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ConnectorsClient.sync
JsonNode sync(String name, Object body)
Lancer une synchronisation. Met en file une synchronisation (202) et publie connectors.<nom>.sync pour le worker. Le manifeste doit déclarer un mode de synchronisation (409 sync_disabled), le connecteur doit être actif (409 connector_disabled), les ressources doivent être lisibles (400 invalid_request) et aucune autre exécution ne doit être en file ou en cours (409 sync_in_progress). Une synchronisation incrémentale part du curseur de la dernière exécution réussie sauf avec full. La politique connector.sync est évaluée. Demande tenant_admin, developer ou agent. Audité sous connector.sync.
Route : /v1/connectors/{name}/sync (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom du connecteur. | |
body | Object | oui | Ressources et indicateur de synchronisation complète facultatifs. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Lancer une synchronisation ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ConnectorsClient.syncRuns
Page<JsonNode> syncRuns(String name)
Lister les synchronisations d'un connecteur. Exécutions de synchronisation du connecteur, de la plus récente à la plus ancienne : mode, statut, ressources, curseur et dates.
Route : /v1/connectors/{name}/sync-runs (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom du connecteur. |
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les synchronisations d'un connecteur ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ConnectorsClient.syncRuns
Page<JsonNode> syncRuns(String name, Map<String, ?> query)
Lister les synchronisations d'un connecteur. Exécutions de synchronisation du connecteur, de la plus récente à la plus ancienne : mode, statut, ressources, curseur et dates.
Route : /v1/connectors/{name}/sync-runs (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom du connecteur. | |
query | Map<String, ?> | oui | Paramètres de la chaîne de requête de la route. |
Retour : Page<JsonNode>. Réponse JSON décodée de l'opération « Lister les synchronisations d'un connecteur ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ConnectorsClient.test
JsonNode test(String name)
Tester un connecteur. Construit les en-têtes d'authentification à partir des identifiants enregistrés et, quand le manifeste a une URL de base, lui envoie un GET. Renvoie ok, credentials, http_status, latency_ms et un code error en cas d'échec (egress_denied, upstream_unavailable, erreurs d'identifiants) ; un test en échec est un 200 avec ok: false. La politique connector.test est évaluée. Demande tenant_admin, developer ou application_owner. Audité sous connector.test.
Route : /v1/connectors/{name}/test (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom du connecteur. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Tester un connecteur ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ConnectorsClient.update
JsonNode update(String name, Object body)
Modifier un connecteur. Modifie le statut ou le propriétaire. Désactiver un connecteur révoque immédiatement ses baux d'identifiants. Demande tenant_admin, developer ou application_owner. Audité sous connector.update.
Route : /v1/connectors/{name} (PATCH).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom du connecteur. | |
body | Object | oui | Champs à modifier ; ceux omis sont conservés. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Modifier un connecteur ».
Erreurs levées : les erreurs typées du transport (Erreurs).
ConnectorsClient.update
JsonNode update(String name, Object body, RequestOptions options)
Modifier un connecteur. Modifie le statut ou le propriétaire. Désactiver un connecteur révoque immédiatement ses baux d'identifiants. Demande tenant_admin, developer ou application_owner. Audité sous connector.update.
Route : /v1/connectors/{name} (PATCH).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | String | oui | Nom du connecteur. | |
body | Object | oui | Champs à modifier ; ceux omis sont conservés. | |
options | RequestOptions | oui | Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation). |
Retour : JsonNode. Réponse JSON décodée de l'opération « Modifier un connecteur ».
Erreurs levées : les erreurs typées du transport (Erreurs).