org.apache.nifi.controller.queue

Interface ListFlowFileStatus

public interface ListFlowFileStatus

Method Summary

Methods

Modifier and Type	Method and Description
int	getCompletionPercentage()
String	getFailureReason()
List<FlowFileSummary>	getFlowFileSummaries()
long	getLastUpdated()
int	getMaxResults()
QueueSize	getQueueSize()
String	getRequestIdentifier()
long	getRequestSubmissionTime()
ListFlowFileState	getState()

Method Detail

getMaxResults

int getMaxResults()

Returns:

the maximum number of FlowFile Summary objects that should be returned

getRequestIdentifier

String getRequestIdentifier()

Returns:

the identifier of the request to drop FlowFiles from the queue

getRequestSubmissionTime

long getRequestSubmissionTime()

Returns:

the date/time (in milliseconds since epoch) at which the request to drop the FlowFiles from a queue was submitted

getLastUpdated

long getLastUpdated()

Returns:

the date/time (in milliseconds since epoch) at which the status of the request was last updated

getState

ListFlowFileState getState()

Returns:

the current state of the operation

getFailureReason

String getFailureReason()

Returns:

the reason that the state is set to a Failure state, or null if the state is not ListFlowFileStatus#FAILURE.

getQueueSize

QueueSize getQueueSize()

Returns:

the current size of the queue

getFlowFileSummaries

List<FlowFileSummary> getFlowFileSummaries()

Returns:

a List of FlowFileSummary objects

getCompletionPercentage

int getCompletionPercentage()

Returns:

the percentage (an integer between 0 and 100, inclusive) of how close the request is to being completed