org.apache.nifi.provenance.lineage

Interface ComputeLineageSubmission

All Known Implementing Classes:

AsyncLineageSubmission

public interface ComputeLineageSubmission

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the lineage computation
java.lang.Long	getExpandedEventId() If the Lineage Computation Type of this submission is LineageComputationType.EXPAND_CHILDREN or LineageComputationType.EXPAND_PARENTS, indicates the event ID that is to be expanded.
LineageComputationType	getLineageComputationType()
java.util.Collection<java.lang.String>	getLineageFlowFileUuids()
java.lang.String	getLineageIdentifier()
ComputeLineageResult	getResult()
java.util.Date	getSubmissionTime()
java.lang.String	getSubmitterIdentity()
boolean	isCanceled()

Method Detail

getResult

ComputeLineageResult getResult()

Returns:

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

getSubmissionTime

java.util.Date getSubmissionTime()

Returns:

the date at which this lineage was submitted

getSubmitterIdentity

java.lang.String getSubmitterIdentity()

Returns:

the identity of the user who submitted the request

getLineageIdentifier

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

java.lang.Long getExpandedEventId()

If the Lineage Computation Type of this submission is LineageComputationType.EXPAND_CHILDREN or LineageComputationType.EXPAND_PARENTS, indicates the event ID that is to be expanded. If the Lineage Computation Type of this submission is 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

java.util.Collection<java.lang.String> getLineageFlowFileUuids()

Returns:

all FlowFile UUID's that are encapsulated in this lineage computation submission