Package org.odpi.openmetadata.viewservices.lineagelinker.server.spring

Class LineageLinkerResource

java.lang.Object

org.odpi.openmetadata.viewservices.lineagelinker.server.spring.LineageLinkerResource

@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}")
public class LineageLinkerResource
extends Object

The LineageLinkerResource provides part of the server-side implementation of the Lineage Linker OMVS. =

Constructor Summary

Constructors

Constructor	Description
LineageLinkerResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
VoidResponse	detachLineage(String serverName, String urlMarker, String lineageRelationshipGUID, DeleteRequestBody requestBody)	Remove a lineage relationship between two elements.
GUIDResponse	linkLineage(String serverName, String urlMarker, String elementOneGUID, String relationshipTypeName, String elementTwoGUID, NewRelationshipRequestBody requestBody)	Create a lineage relationship between two elements that indicates that data is flowing from one element to another.
VoidResponse	updateLineage(String serverName, String urlMarker, String lineageRelationshipGUID, UpdateRelationshipRequestBody requestBody)	Update the lineage relationship.

Methods inherited from class java.lang.Object

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

Constructor Details

LineageLinkerResource

public LineageLinkerResource()

Default constructor

Method Details

linkLineage

@PostMapping(path="/elements/{elementOneGUID}/{relationshipTypeName}/{elementTwoGUID}/attach")
public GUIDResponse linkLineage(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementOneGUID,
 @PathVariable
 String relationshipTypeName,
 @PathVariable
 String elementTwoGUID,
 @RequestBody
 NewRelationshipRequestBody requestBody)

Create a lineage relationship between two elements that indicates that data is flowing from one element to another.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

elementOneGUID - unique identifier of the element at end one

elementTwoGUID - unique identifier of the element at end two

relationshipTypeName - lineage relationship name

requestBody - the properties of the relationship

Returns:

relationship guid or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

updateLineage

@PostMapping(path="/relationships/{lineageRelationshipGUID}/update")
public VoidResponse updateLineage(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String lineageRelationshipGUID,
 @RequestBody
 UpdateRelationshipRequestBody requestBody)

Update the lineage relationship.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

lineageRelationshipGUID - unique identifier for the relationship

requestBody - the properties of the relationship

Returns:

void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

detachLineage

@PostMapping(path="/relationships/{lineageRelationshipGUID}/detach")
public VoidResponse detachLineage(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String lineageRelationshipGUID,
 @RequestBody
 DeleteRequestBody requestBody)

Remove a lineage relationship between two elements.

Parameters:

serverName - name of the server instance to connect to

urlMarker - view service URL marker

lineageRelationshipGUID - unique identifier of the lineage relationship

requestBody - external source information.

Returns:

void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem