Class OpenLineageClient
java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
org.odpi.openmetadata.governanceservers.openlineage.client.OpenLineageClient
- All Implemented Interfaces:
OpenLineageInterface
-
Field Summary
FieldsFields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
auditLog, exceptionHandler, serverName, serverPlatformURLRoot
-
Constructor Summary
ConstructorsConstructorDescriptionOpenLineageClient
(String serverName, String serverPlatformURLRoot) Create a new OpenLineage client.OpenLineageClient
(String serverName, String serverPlatformURLRoot, String userId, String password) -
Method Summary
Modifier and TypeMethodDescriptiongetElementHierarchy
(String userId, ElementHierarchyRequest elementHierarchyRequest) getEntityDetails
(String userId, String guid) Returns the graph that the user will initially see when querying lineage.search
(String userId, LineageSearchRequest lineageSearchRequest) Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
callBooleanGetRESTCall, callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, callOCFConnectorReportGetRESTCall, callStringMapGetRESTCall, callVoidGetRESTCall, callVoidPostRESTCall
Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
callDeleteRESTCall, callDeleteRESTCall, callGetRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall, callPutRESTCall
-
Field Details
-
TYPES
- See Also:
-
NODES
- See Also:
-
-
Constructor Details
-
OpenLineageClient
public OpenLineageClient(String serverName, String serverPlatformURLRoot) throws InvalidParameterException Create a new OpenLineage client.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST services- Throws:
InvalidParameterException
- if parameter validation fails
-
OpenLineageClient
public OpenLineageClient(String serverName, String serverPlatformURLRoot, String userId, String password) throws InvalidParameterException - Throws:
InvalidParameterException
-
-
Method Details
-
lineage
public LineageVerticesAndEdges lineage(String userId, Scope scope, String guid, 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.- Specified by:
lineage
in interfaceOpenLineageInterface
- 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.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 invalidPropertyServerException
- problem contacting the metadata serverOpenLineageException
- open lineage exceptionInvalidParameterException
-
getEntityDetails
public LineageVertex getEntityDetails(String userId, String guid) throws InvalidParameterException, PropertyServerException, OpenLineageException -
getTypes
public List<String> getTypes(String userId) throws PropertyServerException, InvalidParameterException, OpenLineageException -
getNodes
public List<String> getNodes(String userId, String type, String searchValue, int limit) throws PropertyServerException, InvalidParameterException, OpenLineageException -
search
public List<LineageVertex> search(String userId, LineageSearchRequest lineageSearchRequest) throws InvalidParameterException, PropertyServerException, OpenLineageException -
getElementHierarchy
public LineageVerticesAndEdges getElementHierarchy(String userId, ElementHierarchyRequest elementHierarchyRequest) throws InvalidParameterException, PropertyServerException, OpenLineageException
-