Package org.odpi.openmetadata.governanceservers.openlineage.handlers

Class OpenLineageHandler

java.lang.Object
org.odpi.openmetadata.governanceservers.openlineage.handlers.OpenLineageHandler
public class OpenLineageHandler extends Object

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenLineageHandler(org.odpi.openmetadata.governanceservers.openlineage.OpenLineageQueryService openLineageQueryService)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.governanceservers.openlineage.responses.LineageResponse
    getElementHierarchy(org.odpi.openmetadata.governanceservers.openlineage.requests.ElementHierarchyRequest elementHierarchyRequest)
    Returns a subraph representing the hierarchy of a certain node, based on the request
    org.odpi.openmetadata.governanceservers.openlineage.responses.LineageVertexResponse
    getEntityDetails(String guid)
    Gets entity details.
    org.odpi.openmetadata.governanceservers.openlineage.responses.LineageNodeNamesResponse
    getNodes(org.odpi.openmetadata.governanceservers.openlineage.model.NodeNamesSearchCriteria searchCriteria)
    Gets nodes names of certain type with display name containing a certain value - case insensitive
    org.odpi.openmetadata.governanceservers.openlineage.responses.LineageTypesResponse
    getTypes()
    Gets available entities types from lineage repository.
    org.odpi.openmetadata.governanceservers.openlineage.responses.LineageResponse
    lineage(org.odpi.openmetadata.governanceservers.openlineage.model.Scope scope, String guid, boolean includeProcesses)
    Returns a lineage subgraph.
    org.odpi.openmetadata.governanceservers.openlineage.responses.LineageSearchResponse
    search(org.odpi.openmetadata.governanceservers.openlineage.requests.LineageSearchRequest request)
    Gets entity details.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OpenLineageHandler

      public OpenLineageHandler(org.odpi.openmetadata.governanceservers.openlineage.OpenLineageQueryService openLineageQueryService)

  • Method Details

    • lineage

      public org.odpi.openmetadata.governanceservers.openlineage.responses.LineageResponse lineage(org.odpi.openmetadata.governanceservers.openlineage.model.Scope scope, String guid, boolean includeProcesses) throws org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException
      Returns a lineage subgraph.
      Parameters:
      scope - source-and-destination, end-to-end, ultimate-source, ultimate-destination, glossary.
      guid - The guid of the node of which the lineage is queried from.
      includeProcesses -
      Returns:
      A subgraph containing all relevant paths, in graphSON format.
      Throws:
      org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException

    • getEntityDetails

      public org.odpi.openmetadata.governanceservers.openlineage.responses.LineageVertexResponse getEntityDetails(String guid)
      Gets entity details.
      Parameters:
      guid - the guid
      Returns:
      the entity details

    • search

      public org.odpi.openmetadata.governanceservers.openlineage.responses.LineageSearchResponse search(org.odpi.openmetadata.governanceservers.openlineage.requests.LineageSearchRequest request)
      Gets entity details.
      Parameters:
      request - the request
      Returns:
      the entity details

    • getTypes

      public org.odpi.openmetadata.governanceservers.openlineage.responses.LineageTypesResponse getTypes()
      Gets available entities types from lineage repository.
      Returns:
      the available entities types

    • getNodes

      public org.odpi.openmetadata.governanceservers.openlineage.responses.LineageNodeNamesResponse getNodes(org.odpi.openmetadata.governanceservers.openlineage.model.NodeNamesSearchCriteria searchCriteria)
      Gets nodes names of certain type with display name containing a certain value - case insensitive
      Parameters:
      searchCriteria - contains the type of the node names to search for, a search string being part of the display name of the nodes, the maximum number of node names to retrieve
      Returns:
      the node names that match criteria

    • getElementHierarchy

      public org.odpi.openmetadata.governanceservers.openlineage.responses.LineageResponse getElementHierarchy(org.odpi.openmetadata.governanceservers.openlineage.requests.ElementHierarchyRequest elementHierarchyRequest)
      Returns a subraph representing the hierarchy of a certain node, based on the request
      Parameters:
      elementHierarchyRequest - contains the guid of the queried node and the hierarchyType of the display name of the nodes, the maximum number of node names to retrieve
      Returns:
      nodes and edges representing the element hierarchy