io.enterpriseai.resources.LineageClient
Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/LineageClient.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 LineageClient
Lignage. Lignage des données du tenant, alimenté par des événements OpenLineage : quels traitements lisent quels jeux de données et en produisent d'autres.
Constructeur LineageClient
LineageClient(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. |
LineageClient.dataset
JsonNode dataset(String id)
Lire le lignage d'un jeu de données. Renvoie le nœud du jeu de données, les traitements qui le produisent (produced_by), ceux qui le consomment (consumed_by) et ses graphes amont et aval jusqu'à depth sauts. Ouvert à tout membre du tenant. Répond 404 not_found pour un jeu de données inconnu.
Route : /v1/lineage/datasets/{dataset_id} (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Clé du jeu de données, dataset:<namespace>:<name> ou <namespace>:<name> (le préfixe est ajouté), encodée pour l'URL. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Lire le lignage d'un jeu de données ».
Erreurs levées : les erreurs typées du transport (Erreurs).
LineageClient.dataset
JsonNode dataset(String id, Map<String, ?> query)
Lire le lignage d'un jeu de données. Renvoie le nœud du jeu de données, les traitements qui le produisent (produced_by), ceux qui le consomment (consumed_by) et ses graphes amont et aval jusqu'à depth sauts. Ouvert à tout membre du tenant. Répond 404 not_found pour un jeu de données inconnu.
Route : /v1/lineage/datasets/{dataset_id} (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
id | String | oui | Clé du jeu de données, dataset:<namespace>:<name> ou <namespace>:<name> (le préfixe est ajouté), encodée pour l'URL. | |
query | Map<String, ?> | oui | Paramètres de la chaîne de requête de la route. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Lire le lignage d'un jeu de données ».
Erreurs levées : les erreurs typées du transport (Erreurs).
LineageClient.emit
JsonNode emit(Object body)
Envoyer des événements OpenLineage. Accepte un RunEvent OpenLineage ou {"events": [RunEvent, ...]}, en une transaction. Chaque événement exige run.runId, job.namespace et job.name ; eventType vaut START, RUNNING, COMPLETE, ABORT, FAIL ou OTHER (par défaut ; toute autre valeur répond 400) ; eventTime vaut par défaut l'heure de réception.
Route : /v1/lineage/events (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Un RunEvent OpenLineage, ou un objet events qui en contient une liste. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Envoyer des événements OpenLineage ».
Erreurs levées : les erreurs typées du transport (Erreurs).
LineageClient.emit
JsonNode emit(Object body, RequestOptions options)
Envoyer des événements OpenLineage. Accepte un RunEvent OpenLineage ou {"events": [RunEvent, ...]}, en une transaction. Chaque événement exige run.runId, job.namespace et job.name ; eventType vaut START, RUNNING, COMPLETE, ABORT, FAIL ou OTHER (par défaut ; toute autre valeur répond 400) ; eventTime vaut par défaut l'heure de réception.
Route : /v1/lineage/events (POST).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
body | Object | oui | Un RunEvent OpenLineage, ou un objet events qui en contient une liste. | |
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 « Envoyer des événements OpenLineage ».
Erreurs levées : les erreurs typées du transport (Erreurs).
LineageClient.graph
JsonNode graph()
Lire le graphe de lignage. Renvoie nodes et edges. Avec node, le graphe est parcouru depuis ce nœud dans la direction direction jusqu'à depth sauts (404 not_found pour un nœud inconnu). Sans node, renvoie jusqu'à limit nœuds de traitements et de jeux de données triés par clé, et les arêtes qui les relient. Une direction autre que both, upstream ou downstream répond 400 invalid_request. Ouvert à tout membre du tenant.
Route : /v1/lineage/graph (GET).
Cet élément ne prend aucun paramètre.
Retour : JsonNode. Réponse JSON décodée de l'opération « Lire le graphe de lignage ».
Erreurs levées : les erreurs typées du transport (Erreurs).
LineageClient.graph
JsonNode graph(Map<String, ?> query)
Lire le graphe de lignage. Renvoie nodes et edges. Avec node, le graphe est parcouru depuis ce nœud dans la direction direction jusqu'à depth sauts (404 not_found pour un nœud inconnu). Sans node, renvoie jusqu'à limit nœuds de traitements et de jeux de données triés par clé, et les arêtes qui les relient. Une direction autre que both, upstream ou downstream répond 400 invalid_request. Ouvert à tout membre du tenant.
Route : /v1/lineage/graph (GET).
| Nom | Type | Défaut | Requis | Description |
|---|---|---|---|---|
query | Map<String, ?> | oui | Paramètres de la chaîne de requête de la route. |
Retour : JsonNode. Réponse JSON décodée de l'opération « Lire le graphe de lignage ».
Erreurs levées : les erreurs typées du transport (Erreurs).