Package org.odpi.openmetadata.governanceservers.openlineage.client

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
public class OpenLineageClient extends org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient implements OpenLineageInterface

  • Field Summary

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

  • Constructor Summary

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

  • Method Summary

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

    callPostRESTCallNoParams

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • OpenLineageClient

      public OpenLineageClient(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

    • OpenLineageClient

      public OpenLineageClient(String serverName, String serverPlatformURLRoot, String userId, String password) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

  • Method Details

    • lineage

      public org.odpi.openmetadata.governanceservers.openlineage.model.LineageVerticesAndEdges lineage(String userId, org.odpi.openmetadata.governanceservers.openlineage.model.Scope scope, String guid, boolean includeProcesses) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.governanceservers.openlineage.ffdc.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 interface OpenLineageInterface
      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
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem contacting the metadata server
      org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException - open lineage exception
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

    • getEntityDetails

      public org.odpi.openmetadata.governanceservers.openlineage.model.LineageVertex getEntityDetails(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException

    • getTypes

      public List<String> getTypes(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException

    • getNodes

      public List<String> getNodes(String userId, String type, String searchValue, int limit) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException

    • search

      public List<org.odpi.openmetadata.governanceservers.openlineage.model.LineageVertex> search(String userId, org.odpi.openmetadata.governanceservers.openlineage.requests.LineageSearchRequest lineageSearchRequest) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException

    • getElementHierarchy

      public org.odpi.openmetadata.governanceservers.openlineage.model.LineageVerticesAndEdges getElementHierarchy(String userId, org.odpi.openmetadata.governanceservers.openlineage.requests.ElementHierarchyRequest elementHierarchyRequest) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException