org.odpi.openmetadata.userinterface.uichassis.springboot.api.lineage

Class OpenLineageController

java.lang.Object

org.odpi.openmetadata.userinterface.uichassis.springboot.api.lineage.OpenLineageController

@RestController
 @RequestMapping(value="/api/lineage")
public class OpenLineageController
extends Object

This controller serves all requests for retrieving lineage details, both vertical and horizontal

Constructor Summary

Constructors

Constructor and Description
OpenLineageController()

Method Summary

Modifier and Type	Method and Description
Map<String,List>	endToEndLineage(String guid, boolean includeProcesses)
Map<String,List>	glossaryLineage(String guid, boolean includeProcesses)
void	initBinder(org.springframework.web.bind.WebDataBinder webdataBinder) This method is registering a custom converter for View and Scope enums in order to be able to use in url the text of the enum and not the actual name
Map<String,List>	sourceAndDestinationLineage(String guid, boolean includeProcesses)
Map<String,List>	ultimateDestination(String guid, boolean includeProcesses)
Map<String,List>	ultimateSourceGraph(String guid, boolean includeProcesses)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenLineageController

public OpenLineageController()

Method Detail

ultimateSourceGraph

@GetMapping(value="/entities/{guid}/ultimate-source")
public Map<String,List> ultimateSourceGraph(@PathVariable(value="guid")
                                                                                                  String guid,
                                                                                                  @RequestParam
                                                                                                  boolean includeProcesses)

Parameters:

guid - unique identifier of the asset

Returns:

map of nodes and edges describing the ultimate sources of the asset

endToEndLineage

@GetMapping(value="/entities/{guid}/end2end")
 @ResponseBody
public Map<String,List> endToEndLineage(@PathVariable(value="guid")
                                                                                                     String guid,
                                                                                                     @RequestParam
                                                                                                     boolean includeProcesses)

Parameters:

guid - unique identifier of the asset

Returns:

map of nodes and edges describing the end to end flow

ultimateDestination

@GetMapping(value="/entities/{guid}/ultimate-destination")
public Map<String,List> ultimateDestination(@PathVariable(value="guid")
                                                                                                       String guid,
                                                                                                       @RequestParam
                                                                                                       boolean includeProcesses)

Parameters:

guid - unique identifier of the asset

Returns:

map of nodes and edges describing the ultimate destination of the asset

glossaryLineage

@GetMapping(value="/entities/{guid}/glossary-lineage")
public Map<String,List> glossaryLineage(@PathVariable(value="guid")
                                                                                               String guid,
                                                                                               @RequestParam
                                                                                               boolean includeProcesses)

Parameters:

guid - unique identifier of the glossary term

Returns:

map of nodes and edges describing the assets linked to the glossary term

sourceAndDestinationLineage

@GetMapping(value="/entities/{guid}/source-and-destination")
public Map<String,List> sourceAndDestinationLineage(@PathVariable(value="guid")
                                                                                                                 String guid,
                                                                                                                 @RequestParam
                                                                                                                 boolean includeProcesses)

Parameters:

guid - unique identifier of the asset

Returns:

map of nodes and edges describing the ultimate source and destination of the asset

initBinder

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

This method is registering a custom converter for View and Scope enums in order to be able to use in url the text of the enum and not the actual name

Parameters:

webdataBinder - DataBinder for data binding from web request parameters to JavaBean objects