org.odpi.openmetadata.governanceservers.openlineage.server.spring

Class OpenLineageResource

java.lang.Object

org.odpi.openmetadata.governanceservers.openlineage.server.spring.OpenLineageResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/open-lineage/users/{userId}")
public class OpenLineageResource
extends Object

* The OpenLineageResource provides the server-side interface of the Open Lineage Services governance server.

Constructor Summary

Constructors

Constructor and Description
OpenLineageResource()

Method Summary

Modifier and Type	Method and Description
VoidResponse	dumpGraph(String userId, String serverName, String graph) Write an entire graph to disc in the Egeria root folder, in the .GraphMl format.
String	exportGraph(String userId, String serverName, String graph) Return an entire graph, in GraphSON format.
void	initBinder(org.springframework.web.bind.WebDataBinder webdataBinder)
String	lineage(String serverName, String userId, String graph, 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

OpenLineageResource

public OpenLineageResource()

Method Detail

lineage

@GetMapping(path="/lineage/sources/{graph}/scopes/{scope}/views/{view}/entities/{guid}",
            produces="application/json")
public String lineage(@PathVariable(value="serverName")
                                                                                                                                                        String serverName,
                                                                                                                                                        @PathVariable(value="userId")
                                                                                                                                                        String userId,
                                                                                                                                                        @PathVariable(value="graph")
                                                                                                                                                        String graph,
                                                                                                                                                        @PathVariable(value="scope")
                                                                                                                                                        Scope scope,
                                                                                                                                                        @PathVariable(value="view")
                                                                                                                                                        View view,
                                                                                                                                                        @PathVariable(value="guid")
                                                                                                                                                        String guid)

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.

serverName - name of the server instance to connect to.

view - The view queried by the user: hostview, tableview, columnview.

scope - ultimate-source, ultimate-destination, glossary.

graph - main, buffer, mock, history.

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

Returns:

A subgraph containing all relevant paths, in graphSON format.

dumpGraph

@GetMapping(path="/dump/sources/{graph}")
public VoidResponse dumpGraph(@PathVariable(value="userId")
                                                                        String userId,
                                                                        @PathVariable(value="serverName")
                                                                        String serverName,
                                                                        @PathVariable(value="graph")
                                                                        String graph)

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

Parameters:

userId - calling user.

serverName - name of the server instance to connect to.

graph - MAIN, BUFFER, MOCK, HISTORY.

Returns:

Voidresponse

exportGraph

@GetMapping(path="/export/sources/{graph}",
            produces="application/json")
public String exportGraph(@PathVariable(value="userId")
                                                                                                               String userId,
                                                                                                               @PathVariable(value="serverName")
                                                                                                               String serverName,
                                                                                                               @PathVariable(value="graph")
                                                                                                               String graph)

Return an entire graph, in GraphSON format.

Parameters:

userId - calling user.

serverName - name of the server instance to connect to.

graph - MAIN, BUFFER, MOCK, HISTORY.

Returns:

The queried graph, in graphSON format.

initBinder

@InitBinder
public void initBinder(org.springframework.web.bind.WebDataBinder webdataBinder)