org.apache.nifi.provenance.search

Interface QueryResult

public interface QueryResult

Method Summary

Modifier and Type	Method and Description
boolean	awaitCompletion(long time, TimeUnit unit)
String	getError()
Date	getExpiration()
List<ProvenanceEventRecord>	getMatchingEvents()
int	getPercentComplete()
long	getQueryTime()
long	getTotalHitCount()
boolean	isFinished()

Method Detail

getMatchingEvents

List<ProvenanceEventRecord> getMatchingEvents()

Returns:

the Provenance events that match the query (up to the limit specified in the query)

getTotalHitCount

long getTotalHitCount()

Returns:

the total number of Provenance Events that hit

getQueryTime

long getQueryTime()

Returns:

the number of milliseconds the query took to run

getExpiration

Date getExpiration()

Returns:

the date at which this QueryResult will expire

getError

String getError()

Returns:

If an error occurred while computing the lineage, this will return the serialized error; otherwise, returns null

getPercentComplete

int getPercentComplete()

Returns:

an integer between 0 and 100 (inclusive) that indicates what percentage of completion the query has reached

isFinished

boolean isFinished()

Returns:

Indicates whether or not the query has finished running

awaitCompletion

boolean awaitCompletion(long time,
                        TimeUnit unit)
                 throws InterruptedException

Throws:

InterruptedException