org.odpi.openmetadata.governanceservers.openlineage.client

Class OpenLineageClient

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

org.odpi.openmetadata.governanceservers.openlineage.client.OpenLineageClient

All Implemented Interfaces:

OpenLineageInterface

public class OpenLineageClient
extends FFDCRESTClient
implements OpenLineageInterface

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor and Description
OpenLineageClient(String serverName, String serverPlatformURLRoot) Create a new OpenLineage client.
OpenLineageClient(String serverName, String serverPlatformURLRoot, String userId, String password)

Method Summary

Modifier and Type	Method and Description
LineageVertex	getEntityDetails(String userId, String guid)
LineageVerticesAndEdges	lineage(String userId, Scope scope, String guid, String displayNameMustContain, boolean includeProcesses) Returns the graph that the user will initially see when querying lineage.

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

callConnectorTypeGetRESTCall, callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, callStringMapGetRESTCall, callVoidGetRESTCall, callVoidPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

callDeleteRESTCall, callDeleteRESTCall, callGetRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall, callPutRESTCall

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenLineageClient

public OpenLineageClient(String serverName,
                         String serverPlatformURLRoot)
                  throws InvalidParameterException

Create a new OpenLineage client.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

Throws:

InvalidParameterException - if parameter validation fails

OpenLineageClient

public OpenLineageClient(String serverName,
                         String serverPlatformURLRoot,
                         String userId,
                         String password)
                  throws InvalidParameterException

Throws:

InvalidParameterException

Method Detail

lineage

public LineageVerticesAndEdges lineage(String userId,
                                       Scope scope,
                                       String guid,
                                       String displayNameMustContain,
                                       boolean includeProcesses)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       OpenLineageException

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.

Specified by:

lineage in interface OpenLineageInterface

Parameters:

userId - calling user.

scope - ULTIMATE_SOURCE, ULTIMATE_DESTINATION, SOURCE_AND_DESTINATION, VERTICAL, END_TO_END.

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

displayNameMustContain - Used to filter out nodes which displayname does not contain this value.

includeProcesses - Will filter out all processes and subprocesses from the response if false.

Returns:

A subgraph containing all relevant paths, in graphSON format.

Throws:

InvalidParameterException - one of the parameters is null or invalid

InvalidParameterException

PropertyServerException

OpenLineageException

getEntityDetails

public LineageVertex getEntityDetails(String userId,
                                      String guid)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      OpenLineageException

Throws:

InvalidParameterException

PropertyServerException

OpenLineageException