Package org.odpi.openmetadata.governanceservers.openlineage

Interface OpenLineageQueryService

All Known Implementing Classes:
LineageGraphQueryService
public interface OpenLineageQueryService

  • Method Details

    • lineage

      LineageResponse lineage(Scope scope, String guid, boolean includeProcesses) throws OpenLineageException
      Retrieve lineage starting from the entity identified by the guid
      Parameters:
      scope - the type of lineage to retrieve
      guid - the guid of the entity from which to start
      includeProcesses -
      Returns:
      the lineage vertices and edges that compose the graph
      Throws:
      OpenLineageException

    • getEntityDetails

      LineageVertexResponse getEntityDetails(String guid)
      Gets entity details.
      Parameters:
      guid - the guid
      Returns:
      the entity details

    • search

      LineageSearchResponse search(LineageSearchRequest request)
      Search the database for entities matching the search request
      Parameters:
      request - the criteria for the search
      Returns:
      all the entities in the graph that match the criteria

    • getTypes

      LineageTypesResponse getTypes()
      Gets available entities types from lineage repository.
      Returns:
      the available entities types

    • getNodes

      LineageNodeNamesResponse getNodes(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

      LineageResponse getElementHierarchy(ElementHierarchyRequest elementHierarchyRequest)
      Retrieve hierarchy starting from the entity identified by the guid
      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:
      the lineage vertices and edges that compose the hierarchy