Package org.odpi.openmetadata.governanceservers.lineagewarehouse.client

Class LineageWarehouseClientWarehouse

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

org.odpi.openmetadata.governanceservers.lineagewarehouse.client.LineageWarehouseClientWarehouse

All Implemented Interfaces:

LineageWarehouseInterface

public class LineageWarehouseClientWarehouse
extends FFDCRESTClient
implements LineageWarehouseInterface

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NODES
static final String	TYPES

Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
LineageWarehouseClientWarehouse(String serverName, String serverPlatformURLRoot)	Create a new OpenLineage client.
LineageWarehouseClientWarehouse(String serverName, String serverPlatformURLRoot, String userId, String password)

Method Summary

Modifier and Type	Method	Description
LineageVerticesAndEdges	getElementHierarchy(String userId, ElementHierarchyRequest elementHierarchyRequest)
LineageVertex	getEntityDetails(String userId, String guid)
List<String>	getNodes(String userId, String type, String searchValue, int limit)
List<String>	getTypes(String userId)
LineageVerticesAndEdges	lineage(String userId, Scope scope, String guid, boolean includeProcesses)	Returns the graph that the user will initially see when querying lineage.
List<LineageVertex>	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

Methods inherited from class java.lang.Object

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

Field Details

TYPES

public static final String TYPES

See Also:

• Constant Field Values

NODES

public static final String NODES

See Also:

• Constant Field Values

Constructor Details

LineageWarehouseClientWarehouse

public LineageWarehouseClientWarehouse(String serverName,
 String serverPlatformURLRoot)
                                throws InvalidParameterException

Create a new OpenLineage client.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

Throws:

InvalidParameterException - if parameter validation fails

LineageWarehouseClientWarehouse

public LineageWarehouseClientWarehouse(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,
LineageWarehouseException

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 interface LineageWarehouseInterface

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 invalid

PropertyServerException - problem contacting the metadata server

LineageWarehouseException - open lineage exception

InvalidParameterException

getEntityDetails

public LineageVertex getEntityDetails(String userId,
 String guid)
                               throws InvalidParameterException,
PropertyServerException,
LineageWarehouseException

Throws:

InvalidParameterException

PropertyServerException

LineageWarehouseException

getTypes

public List<String> getTypes(String userId)
                      throws PropertyServerException,
InvalidParameterException,
LineageWarehouseException

Throws:

PropertyServerException

InvalidParameterException

LineageWarehouseException

getNodes

public List<String> getNodes(String userId,
 String type,
 String searchValue,
 int limit)
                      throws PropertyServerException,
InvalidParameterException,
LineageWarehouseException

Throws:

PropertyServerException

InvalidParameterException

LineageWarehouseException

search

public List<LineageVertex> search(String userId,
 LineageSearchRequest lineageSearchRequest)
                           throws InvalidParameterException,
PropertyServerException,
LineageWarehouseException

Throws:

InvalidParameterException

PropertyServerException

LineageWarehouseException

getElementHierarchy

public LineageVerticesAndEdges getElementHierarchy(String userId,
 ElementHierarchyRequest elementHierarchyRequest)
                                            throws InvalidParameterException,
PropertyServerException,
LineageWarehouseException

Throws:

InvalidParameterException

PropertyServerException

LineageWarehouseException