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

Interface OpenLineageInterface

All Known Implementing Classes:
OpenLineageClient
public interface OpenLineageInterface

  • Method Summary

    Modifier and Type
    Method
    Description
    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.

  • Method Details

    • lineage

      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.
      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