org.odpi.openmetadata.governanceservers.openlineage.client

Class OpenLineage

java.lang.Object

org.odpi.openmetadata.governanceservers.openlineage.client.OpenLineage

public class OpenLineage
extends Object

Constructor Summary

Constructors

Constructor and Description
OpenLineage(String serverName, String newServerURL) Create a new OpenLineage client.

Method Summary

Modifier and Type	Method and Description
VoidResponse	dumpGraph(String userId, GraphName graphName) Write an entire graph to disc in the Egeria root folder, in the .GraphMl format.
String	exportGraph(String userId, GraphName graphName) Return an entire graph, in GraphSon format.
String	generateMockGraph(String userId) Generate the MOCK graph, which can be used for performance testing, or demoing lineage with large amounts of data.
String	lineage(String userId, GraphName graphName, Scope scope, View view, String guid) Returns the graph that the user will initially see when querying lineage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenLineage

public OpenLineage(String serverName,
                   String newServerURL)

Create a new OpenLineage client.

Parameters:

serverName - name of the server to connect to.

newServerURL - the network address of the server running the governance engine.

Method Detail

lineage

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

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

dumpGraph

public VoidResponse dumpGraph(String userId,
                              GraphName graphName)
                       throws InvalidParameterException

Write an entire graph to disc in the Egeria root folder, in the .GraphMl format.

Parameters:

userId - calling user.

graphName - MAIN, BUFFER, MOCK, HISTORY.

Returns:

Voidresponse.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

exportGraph

public String exportGraph(String userId,
                          GraphName graphName)
                   throws InvalidParameterException

Return an entire graph, in GraphSon format.

Parameters:

userId - calling user.

graphName - MAIN, BUFFER, MOCK, HISTORY.

Returns:

The queried graph, in graphSON format.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

generateMockGraph

public String generateMockGraph(String userId)
                         throws InvalidParameterException

Generate the MOCK graph, which can be used for performance testing, or demoing lineage with large amounts of data.

Parameters:

userId - calling user.

Returns:

Voidresponse.

Throws:

InvalidParameterException - one of the parameters is null or invalid.