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, Scope scope, String guid, String displaynameMustContain, boolean includeProcesses) Returns the graph that the user will initially see when querying lineage.

Method Detail

lineage

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.

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