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
LineageVertexResponse	getEntityDetails(String serverName, String userId, String guid) Gets entity details.
LineageResponse	lineage(String serverName, String userId, String guid, LineageQueryParameters params) 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

@PostMapping(path="/lineage/entities/{guid}",
             produces="application/json")
public LineageResponse lineage(@PathVariable(value="serverName")
                                                                                                                       String serverName,
                                                                                                                       @PathVariable(value="userId")
                                                                                                                       String userId,
                                                                                                                       @PathVariable(value="guid")
                                                                                                                       String guid,
                                                                                                                       @RequestBody
                                                                                                                       LineageQueryParameters params)

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.

params -

Returns:

A subgraph containing all relevant paths, in graphSON format.

getEntityDetails

@GetMapping(path="/lineage/entities/{guid}/details",
            produces="application/json")
public LineageVertexResponse getEntityDetails(@PathVariable(value="serverName")
                                                                                                                                            String serverName,
                                                                                                                                            @PathVariable(value="userId")
                                                                                                                                            String userId,
                                                                                                                                            @PathVariable(value="guid")
                                                                                                                                            String guid)

Gets entity details.

Parameters:

serverName - the server name

userId - the user id

guid - the guid

Returns:

the entity details