org.apache.nifi.controller.queue

Interface DropFlowFileStatus

public interface DropFlowFileStatus

Represents the status of a Drop FlowFile Request that has been issued to a FlowFileQueue. When a queue is requested to drop its FlowFiles, that process may be rather lengthy in the case of a poorly behaving FlowFileRepository or if the destination Processor is polling from the queue using a filter that is misbehaving. As a result, the dropping of FlowFiles is performed asynchronously. This status object provides information about how far along in the process we currently are and information about the success or failure of the operation.

Method Summary

Modifier and Type	Method and Description
QueueSize	getCurrentSize()
QueueSize	getDroppedSize()
String	getFailureReason()
long	getLastUpdated()
QueueSize	getOriginalSize()
String	getRequestIdentifier()
long	getRequestSubmissionTime()
DropFlowFileState	getState()

Method Detail

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

getOriginalSize

QueueSize getOriginalSize()

Returns:

the size of the queue when the drop request was issued or null if it is not yet known, which can happen if the DropFlowFileState is DropFlowFileState.WAITING_FOR_LOCK.

getCurrentSize

QueueSize getCurrentSize()

Returns:

the current size of the queue or null if it is not yet known

getDroppedSize

QueueSize getDroppedSize()

Returns:

a QueueSize representing the number of FlowFiles that have been dropped for this request and the aggregate size of those FlowFiles

getState

DropFlowFileState 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 DropFlowFileState.FAILURE.