Package org.apache.nifi.provenance.lineage

Interface ComputeLineageSubmission

public interface ComputeLineageSubmission

  • Method Details

    • getResult

      ComputeLineageResult getResult()
      Returns:
      the ComputeLineageResult that contains the results. The results may be partial if a call to ComputeLineageResult.isFinished() returns false

    • getSubmissionTime

      Date getSubmissionTime()
      Returns:
      the date at which this lineage was submitted

    • getSubmitterIdentity

      String getSubmitterIdentity()
      Returns:
      the identity of the user who submitted the request

    • getLineageIdentifier

      String getLineageIdentifier()
      Returns:
      the generated identifier for this lineage result

    • cancel

      void cancel()
      Cancels the lineage computation

    • isCanceled

      boolean isCanceled()
      Returns:
      true if cancel() has been called, false otherwise

    • getLineageComputationType

      LineageComputationType getLineageComputationType()
      Returns:
      the type of Lineage Computation that was submitted

    • getExpandedEventId

      Long getExpandedEventId()
      If the Lineage Computation Type of this submission is
      invalid reference 
      LineageComputationType.EXPAND_CHILDREN
      or
      invalid reference 
      LineageComputationType.EXPAND_PARENTS
      , indicates the event ID that is to be expanded. If the Lineage Computation Type of this submission is
      invalid reference 
      LineageComputationType.FLOWFILE_LINEAGE
      and the original submission was based off an event id, indicates that event ID. Otherwise returns null.
      Returns:
      the event id if applicable

    • getLineageFlowFileUuids

      Collection<String> getLineageFlowFileUuids()
      Returns:
      all FlowFile UUID's that are encapsulated in this lineage computation submission