Interface OpenLineageInterface

  • All Known Implementing Classes:
    OpenLineageClient

    public interface OpenLineageInterface
    • Method Detail

      • lineage

        LineageVerticesAndEdges lineage​(java.lang.String userId,
                                        Scope scope,
                                        java.lang.String guid,
                                        boolean includeProcesses)
                                 throws InvalidParameterException,
                                        PropertyServerException,
                                        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:
        java.security.InvalidParameterException - one of the parameters is null or invalid
        PropertyServerException - problem contacting the metadata server
        OpenLineageException - open lineage exception
        InvalidParameterException