org.apache.nifi.flowfile

Interface FlowFile

All Superinterfaces:

Comparable<FlowFile>

All Known Subinterfaces:

FlowFileRecord

public interface FlowFile
extends Comparable<FlowFile>

A flow file is a logical notion of an item in a flow with its associated attributes and identity which can be used as a reference for its actual content.

All FlowFile implementations must be Immutable - Thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FlowFile.KeyValidator

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttribute(String key) Obtains the attribute value for the given key
Map<String,String>	getAttributes()
long	getEntryDate()
long	getId() Deprecated. This method has been deprecated in favor of using the attribute CoreAttributes.UUID. If an identifier is needed use getAttribute(String) to retrieve the value for this attribute. For example, by calling getAttribute(CoreAttributes.UUID.getKey()).
Long	getLastQueueDate()
Set<String>	getLineageIdentifiers() Deprecated. this collection was erroneously unbounded and caused a lot of OutOfMemoryError problems when dealing with FlowFiles with many ancestors. This Collection is now capped at 100 lineage identifiers. This method was introduced with the idea of providing future performance improvements but due to the high cost of heap consumption will not be used in such a manner. As a result, this method will be removed in a future release.
long	getLineageStartDate()
long	getSize()
boolean	isPenalized()

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getId

@Deprecated
long getId()

Deprecated. This method has been deprecated in favor of using the attribute CoreAttributes.UUID. If an identifier is needed use getAttribute(String) to retrieve the value for this attribute. For example, by calling getAttribute(CoreAttributes.UUID.getKey()).

Returns:

the unique identifier for this flow file

getEntryDate

long getEntryDate()

Returns:

the date at which the flow file entered the flow

getLineageStartDate

long getLineageStartDate()

Returns:

the date at which the origin of this FlowFile entered the flow. For example, if FlowFile Z were derived from FlowFile Y and FlowFile Y was derived from FlowFile X, this date would be the entryDate (see getEntryDate() of FlowFile X.

getLastQueueDate

Long getLastQueueDate()

Returns:

the time at which the FlowFile was most recently added to a FlowFile queue, or null if the FlowFile has never been enqueued. This value will always be populated before it is passed to a FlowFilePrioritizer

getLineageIdentifiers

@Deprecated
Set<String> getLineageIdentifiers()

Deprecated. this collection was erroneously unbounded and caused a lot of OutOfMemoryError problems when dealing with FlowFiles with many ancestors. This Collection is now capped at 100 lineage identifiers. This method was introduced with the idea of providing future performance improvements but due to the high cost of heap consumption will not be used in such a manner. As a result, this method will be removed in a future release.

If a FlowFile is derived from multiple "parent" FlowFiles, all of the parents' Lineage Identifiers will be in the set.

Returns:

a set of identifiers that are unique to this FlowFile's lineage. If FlowFile X is derived from FlowFile Y, both FlowFiles will have the same value for the Lineage Claim ID.

isPenalized

boolean isPenalized()

Returns:

true if flow file is currently penalized; false otherwise;

getAttribute

String getAttribute(String key)

Obtains the attribute value for the given key

Parameters:

key - of the attribute

Returns:

value if found; null otherwise

getSize

long getSize()

Returns:

size of flow file contents in bytes

getAttributes

Map<String,String> getAttributes()

Returns:

an unmodifiable map of the flow file attributes