org.odpi.openmetadata.governanceservers.openlineage.client

Interface OpenLineageInterface

All Known Implementing Classes:

OpenLineageClient

public interface OpenLineageInterface

Method Summary

Modifier and Type	Method and Description
LineageVerticesAndEdges	lineage(String userId, GraphName graphName, Scope scope, View view, String guid) Returns the graph that the user will initially see when querying lineage.

Method Detail

lineage

LineageVerticesAndEdges lineage(String userId,
                                GraphName graphName,
                                Scope scope,
                                View view,
                                String guid)
                         throws InvalidParameterException,
                                PropertyServerException

Returns the graph that the user will initially see when querying lineage. In the future, this method will be extended to condense large paths to prevent cluttering of the users screen. The user will be able to extended the condensed path by querying a different method.

Parameters:

userId - calling user.

graphName - MAIN, BUFFER, MOCK, HISTORY.

scope - ULTIMATE_SOURCE, ULTIMATE_DESTINATION, GLOSSARY.

view - TABLE_VIEW, COLUMN_VIEW.

guid - The guid of the node of which the lineage is queried of.

Returns:

A subgraph containing all relevant paths, in graphSON format.

Throws:

InvalidParameterException - one of the parameters is null or invalid

InvalidParameterException

PropertyServerException