Skip to main content

io.enterpriseai.resources.LineageClient

Source: sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/LineageClient.java. Back to the Java SDK reference index.

note

This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.

Class LineageClient​

OpenLineage events and graph.

Constructor LineageClient​

LineageClient(Transport transport)

Creates the client on the shared transport; EnterpriseAIClient builds it and exposes it through the accessor of the same name.

NameTypeDefaultRequiredDescription
transportTransportyesTransport shared by the sub-clients of one client.

LineageClient.dataset​

JsonNode dataset(String id)

Get the lineage of a dataset. Returns the dataset node, the jobs that produce it (produced_by), the jobs that consume it (consumed_by) and its upstream and downstream graphs up to depth hops. Open to any member of the tenant. Answers 404 not_found for an unknown dataset.

Route: /v1/lineage/datasets/{dataset_id} (GET).

NameTypeDefaultRequiredDescription
idStringyesDataset key, dataset:<namespace>:<name> or <namespace>:<name> (the prefix is added), URL encoded.

Returns: JsonNode. Decoded JSON answer of the operation "Get the lineage of a dataset".

Raises: the typed errors of the transport (Errors).

LineageClient.dataset​

JsonNode dataset(String id, Map<String, ?> query)

Get the lineage of a dataset. Returns the dataset node, the jobs that produce it (produced_by), the jobs that consume it (consumed_by) and its upstream and downstream graphs up to depth hops. Open to any member of the tenant. Answers 404 not_found for an unknown dataset.

Route: /v1/lineage/datasets/{dataset_id} (GET).

NameTypeDefaultRequiredDescription
idStringyesDataset key, dataset:<namespace>:<name> or <namespace>:<name> (the prefix is added), URL encoded.
queryMap<String, ?>yesQuery string parameters of the route.

Returns: JsonNode. Decoded JSON answer of the operation "Get the lineage of a dataset".

Raises: the typed errors of the transport (Errors).

LineageClient.emit​

JsonNode emit(Object body)

Send OpenLineage events. Accepts one OpenLineage RunEvent or {"events": [RunEvent, ...]}, in one transaction. Each event needs run.runId and job.namespace and job.name; eventType is one of START, RUNNING, COMPLETE, ABORT, FAIL or OTHER (default; any other answers 400); eventTime defaults to the reception time.

Route: /v1/lineage/events (POST).

NameTypeDefaultRequiredDescription
bodyObjectyesOne OpenLineage RunEvent, or an object events holding a list of them.

Returns: JsonNode. Decoded JSON answer of the operation "Send OpenLineage events".

Raises: the typed errors of the transport (Errors).

LineageClient.emit​

JsonNode emit(Object body, RequestOptions options)

Send OpenLineage events. Accepts one OpenLineage RunEvent or {"events": [RunEvent, ...]}, in one transaction. Each event needs run.runId and job.namespace and job.name; eventType is one of START, RUNNING, COMPLETE, ABORT, FAIL or OTHER (default; any other answers 400); eventTime defaults to the reception time.

Route: /v1/lineage/events (POST).

NameTypeDefaultRequiredDescription
bodyObjectyesOne OpenLineage RunEvent, or an object events holding a list of them.
optionsRequestOptionsyesPer call options (idempotency key, traceparent, headers, abort signal).

Returns: JsonNode. Decoded JSON answer of the operation "Send OpenLineage events".

Raises: the typed errors of the transport (Errors).

LineageClient.graph​

JsonNode graph()

Get the lineage graph. Returns nodes and edges. With node, the graph is walked from that node in direction up to depth hops (404 not_found for an unknown node). Without node, returns up to limit job and dataset nodes ordered by key, and the edges between them. A direction other than both, upstream or downstream answers 400 invalid_request. Open to any member of the tenant.

Route: /v1/lineage/graph (GET).

This element takes no parameter.

Returns: JsonNode. Decoded JSON answer of the operation "Get the lineage graph".

Raises: the typed errors of the transport (Errors).

LineageClient.graph​

JsonNode graph(Map<String, ?> query)

Get the lineage graph. Returns nodes and edges. With node, the graph is walked from that node in direction up to depth hops (404 not_found for an unknown node). Without node, returns up to limit job and dataset nodes ordered by key, and the edges between them. A direction other than both, upstream or downstream answers 400 invalid_request. Open to any member of the tenant.

Route: /v1/lineage/graph (GET).

NameTypeDefaultRequiredDescription
queryMap<String, ?>yesQuery string parameters of the route.

Returns: JsonNode. Decoded JSON answer of the operation "Get the lineage graph".

Raises: the typed errors of the transport (Errors).