Uses of Interface
org.apache.nifi.flowfile.FlowFile

Packages that use FlowFile

Package	Description
org.apache.nifi.components
org.apache.nifi.expression
org.apache.nifi.processor
org.apache.nifi.provenance

Uses of FlowFile in org.apache.nifi.components

Methods in org.apache.nifi.components with parameters of type FlowFile

Modifier and Type	Method	Description
PropertyValue	PropertyValue.evaluateAttributeExpressions(FlowFile flowFile)	Replaces values in the Property Value using the NiFi Expression Language; a PropertyValue with the new value is then returned, supporting call chaining.
PropertyValue	PropertyValue.evaluateAttributeExpressions(FlowFile flowFile, Map<String,String> additionalAttributes)	Replaces values in the Property Value using the NiFi Expression Language; a PropertyValue with the new value is then returned, supporting call chaining.
PropertyValue	PropertyValue.evaluateAttributeExpressions(FlowFile flowFile, Map<String,String> additionalAttributes, AttributeValueDecorator decorator)	Replaces values in the Property Value using the NiFi Expression Language; a PropertyValue with the new value is then returned, supporting call chaining.
PropertyValue	PropertyValue.evaluateAttributeExpressions(FlowFile flowFile, Map<String,String> additionalAttributes, AttributeValueDecorator decorator, Map<String,String> stateValues)	Replaces values in the Property Value using the NiFi Expression Language; a PropertyValue with the new value is then returned, supporting call chaining.
PropertyValue	PropertyValue.evaluateAttributeExpressions(FlowFile flowFile, AttributeValueDecorator decorator)	Replaces values in the Property Value using the NiFi Expression Language.

Uses of FlowFile in org.apache.nifi.expression

Methods in org.apache.nifi.expression with parameters of type FlowFile

Modifier and Type	Method	Description
String	AttributeExpression.evaluate(FlowFile flowFile)	Evaluates the expression providing access to additional variables including the flow file properties such as file size, identifier, etc..
String	AttributeExpression.evaluate(FlowFile flowFile, AttributeValueDecorator decorator)	Evaluates the expression providing access to additional variables including the flow file properties such as file size, identifier, etc..

Uses of FlowFile in org.apache.nifi.processor

Methods in org.apache.nifi.processor that return FlowFile

Modifier and Type	Method	Description
FlowFile	ProcessSession.append(FlowFile source, OutputStreamCallback writer)	Executes the given {code writer} OutputStreamCallback against the content of the given FlowFile, such that any data written to the OutputStream will be appended to the end of FlowFile's content.
FlowFile	ProcessSession.clone(FlowFile example)	Creates a new FlowFile with a parent linkage to the example FlowFile.
FlowFile	ProcessSession.clone(FlowFile parent, long offset, long size)	Creates a new FlowFile with a parent linkage to the parent FlowFile.
FlowFile	ProcessSession.create()	Creates a new FlowFile in the repository with no content and without any linkage to a parent FlowFile.
FlowFile	ProcessSession.create(Collection<FlowFile> parents)	Creates a new FlowFile in the repository with no content but with a parent linkage to all parents.
FlowFile	ProcessSession.create(FlowFile parent)	Creates a new FlowFile in the repository with no content but with a parent linkage to the parent.
FlowFile	ProcessSession.get()	Returns the FlowFile from the work queue that is next highest priority to process.
FlowFile	ProcessSession.importFrom(InputStream source, FlowFile destination)	Writes to contents of the source InputStream to the given FlowFile's content.
FlowFile	ProcessSession.importFrom(Path source, boolean keepSourceFile, FlowFile destination)	Writes to contents of the file a the source Path to the given FlowFile's content.
FlowFile	ProcessSession.merge(Collection<FlowFile> sources, FlowFile destination)	Combines the content of all given sources FlowFiles into a single given destination FlowFile.
FlowFile	ProcessSession.merge(Collection<FlowFile> sources, FlowFile destination, byte[] header, byte[] footer, byte[] demarcator)	Combines the content of all given sources FlowFiles into a single given destination FlowFile.
FlowFile	ProcessSession.penalize(FlowFile flowFile)	Sets a penalty for the given FlowFile, which will make it unavailable to be operated on any further during the penalty period.
FlowFile	ProcessSession.putAllAttributes(FlowFile flowFile, Map<String,String> attributes)	Updates the given FlowFile's attributes with the given key / value pairs.
FlowFile	ProcessSession.putAttribute(FlowFile flowFile, String key, String value)	Updates the given FlowFile's attributes with the given key / value pair.
FlowFile	ProcessSession.removeAllAttributes(FlowFile flowFile, Pattern keyPattern)	Removes all attributes from the given FlowFile whose key matches the given pattern.
FlowFile	ProcessSession.removeAllAttributes(FlowFile flowFile, Set<String> keys)	Removes the attributes with the given keys from the given FlowFile.
FlowFile	ProcessSession.removeAttribute(FlowFile flowFile, String key)	Removes the attribute with the given key from the given FlowFile.
FlowFile	ProcessSession.write(FlowFile source, OutputStreamCallback writer)	Executes the given {code writer} OutputStreamCallback against the content of the given FlowFile.
FlowFile	ProcessSession.write(FlowFile source, StreamCallback writer)	Executes the given {code writer} StreamCallback against the content of the given FlowFile.

Methods in org.apache.nifi.processor that return types with arguments of type FlowFile

Modifier and Type	Method	Description
List<FlowFile>	ProcessSession.get(int maxResults)	Returns the next up to maxResults FlowFiles from the work queue that are the highest priority to process.
List<FlowFile>	ProcessSession.get(FlowFileFilter filter)	Returns all FlowFiles from all the incoming queues which the given FlowFileFilter accepts.

Methods in org.apache.nifi.processor with parameters of type FlowFile

Modifier and Type	Method	Description
FlowFile	ProcessSession.append(FlowFile source, OutputStreamCallback writer)	Executes the given {code writer} OutputStreamCallback against the content of the given FlowFile, such that any data written to the OutputStream will be appended to the end of FlowFile's content.
FlowFile	ProcessSession.clone(FlowFile example)	Creates a new FlowFile with a parent linkage to the example FlowFile.
FlowFile	ProcessSession.clone(FlowFile parent, long offset, long size)	Creates a new FlowFile with a parent linkage to the parent FlowFile.
FlowFile	ProcessSession.create(FlowFile parent)	Creates a new FlowFile in the repository with no content but with a parent linkage to the parent.
void	ProcessSession.exportTo(FlowFile flowFile, OutputStream destination)	Writes the content of the given FlowFile to given destination OutputStream.
void	ProcessSession.exportTo(FlowFile flowFile, Path destination, boolean append)	Writes the content of the given FlowFile to the file at the given destination Path.
FlowFileFilter.FlowFileFilterResult	FlowFileFilter.filter(FlowFile flowFile)	Indicates whether or not the given FlowFile should be selected and whether or not the Processor is interested in filtering additional FlowFiles
FlowFile	ProcessSession.importFrom(InputStream source, FlowFile destination)	Writes to contents of the source InputStream to the given FlowFile's content.
FlowFile	ProcessSession.importFrom(Path source, boolean keepSourceFile, FlowFile destination)	Writes to contents of the file a the source Path to the given FlowFile's content.
FlowFile	ProcessSession.merge(Collection<FlowFile> sources, FlowFile destination)	Combines the content of all given sources FlowFiles into a single given destination FlowFile.
FlowFile	ProcessSession.merge(Collection<FlowFile> sources, FlowFile destination, byte[] header, byte[] footer, byte[] demarcator)	Combines the content of all given sources FlowFiles into a single given destination FlowFile.
FlowFile	ProcessSession.penalize(FlowFile flowFile)	Sets a penalty for the given FlowFile, which will make it unavailable to be operated on any further during the penalty period.
FlowFile	ProcessSession.putAllAttributes(FlowFile flowFile, Map<String,String> attributes)	Updates the given FlowFile's attributes with the given key / value pairs.
FlowFile	ProcessSession.putAttribute(FlowFile flowFile, String key, String value)	Updates the given FlowFile's attributes with the given key / value pair.
InputStream	ProcessSession.read(FlowFile flowFile)	Provides an InputStream that can be used to read the content of the given FlowFile.
void	ProcessSession.read(FlowFile source, InputStreamCallback reader)	Executes the given {code reader} InputStreamCallback against the content of the given FlowFile.
void	ProcessSession.remove(FlowFile flowFile)	Ends the managed persistence for the given FlowFile.
FlowFile	ProcessSession.removeAllAttributes(FlowFile flowFile, Pattern keyPattern)	Removes all attributes from the given FlowFile whose key matches the given pattern.
FlowFile	ProcessSession.removeAllAttributes(FlowFile flowFile, Set<String> keys)	Removes the attributes with the given keys from the given FlowFile.
FlowFile	ProcessSession.removeAttribute(FlowFile flowFile, String key)	Removes the attribute with the given key from the given FlowFile.
void	ProcessSession.transfer(FlowFile flowFile)	Transfers the given FlowFile back to the work queue from which it was pulled.
void	ProcessSession.transfer(FlowFile flowFile, Relationship relationship)	Transfers the given FlowFile to the appropriate destination processor work queue(s) based on the given relationship.
OutputStream	ProcessSession.write(FlowFile source)	Provides an OutputStream that can be used to write the content of the given FlowFile.
FlowFile	ProcessSession.write(FlowFile source, OutputStreamCallback writer)	Executes the given {code writer} OutputStreamCallback against the content of the given FlowFile.
FlowFile	ProcessSession.write(FlowFile source, StreamCallback writer)	Executes the given {code writer} StreamCallback against the content of the given FlowFile.

Method parameters in org.apache.nifi.processor with type arguments of type FlowFile

Modifier and Type	Method	Description
FlowFile	ProcessSession.create(Collection<FlowFile> parents)	Creates a new FlowFile in the repository with no content but with a parent linkage to all parents.
FlowFile	ProcessSession.merge(Collection<FlowFile> sources, FlowFile destination)	Combines the content of all given sources FlowFiles into a single given destination FlowFile.
FlowFile	ProcessSession.merge(Collection<FlowFile> sources, FlowFile destination, byte[] header, byte[] footer, byte[] demarcator)	Combines the content of all given sources FlowFiles into a single given destination FlowFile.
void	ProcessSession.migrate(ProcessSession newOwner, Collection<FlowFile> flowFiles)	Migrates ownership of the given flowFiles FlowFiles from this session to the given newOwner ProcessSession.
void	ProcessSession.remove(Collection<FlowFile> flowFiles)	Ends the managed persistence for the given FlowFiles.
void	ProcessSession.transfer(Collection<FlowFile> flowFiles)	Transfers the given FlowFiles back to the work queues from which the FlowFiles were pulled.
void	ProcessSession.transfer(Collection<FlowFile> flowFiles, Relationship relationship)	Transfers the given FlowFiles to the appropriate destination processor work queue(s) based on the given relationship.

Uses of FlowFile in org.apache.nifi.provenance

Methods in org.apache.nifi.provenance with parameters of type FlowFile

Modifier and Type	Method	Description
ProvenanceEventBuilder	ProvenanceEventBuilder.addChildFlowFile(FlowFile child)	Adds the given FlowFile as a child for Events of type ProvenanceEventType.FORK, ProvenanceEventType.JOIN, and ProvenanceEventType.CLONE This is valid only for ProvenanceEventType.FORK, ProvenanceEventType.JOIN, and ProvenanceEventType.CLONE events and will be ignored for any other event types.
ProvenanceEventBuilder	ProvenanceEventBuilder.addParentFlowFile(FlowFile parent)	Adds the given FlowFile as a parent for Events of type, ProvenanceEventType.FORK, ProvenanceEventType.JOIN, and ProvenanceEventType.CLONE This is valid only for ProvenanceEventType.FORK, ProvenanceEventType.JOIN, and ProvenanceEventType.CLONE events and will be ignored for any other event types.
void	ProvenanceReporter.associate(FlowFile flowFile, String alternateIdentifierNamespace, String alternateIdentifier)	Emits a Provenance Event of type ADDINFO that provides a linkage between the given FlowFile and alternate identifier.
void	ProvenanceReporter.clone(FlowFile parent, FlowFile child)	Emits a Provenance Event of type CLONE that establishes that the given child is an exact replica of the parent.
void	ProvenanceReporter.create(FlowFile flowFile)	Emits a Provenance Event of type CREATE that indicates that the given FlowFile was created by NiFi from data that was not received from an external entity.
void	ProvenanceReporter.create(FlowFile flowFile, String details)	Emits a Provenance Event of type CREATE that indicates that the given FlowFile was created by NiFi from data that was not received from an external entity.
void	ProvenanceReporter.fetch(FlowFile flowFile, String transitUri)	Emits a Provenance Event of type FETCH that indicates that the content of the given FlowFile was overwritten with the data received from an external source.
void	ProvenanceReporter.fetch(FlowFile flowFile, String transitUri, long transmissionMillis)	Emits a Provenance Event of type FETCH that indicates that the content of the given FlowFile was overwritten with the data received from an external source.
void	ProvenanceReporter.fetch(FlowFile flowFile, String transitUri, String details, long transmissionMillis)	Emits a Provenance Event of type FETCH that indicates that the content of the given FlowFile was overwritten with the data received from an external source.
void	ProvenanceReporter.fork(FlowFile parent, Collection<FlowFile> children)	Emits a Provenance Event of type FORK that establishes that the given parent was split into multiple child FlowFiles.
void	ProvenanceReporter.fork(FlowFile parent, Collection<FlowFile> children, long forkDuration)	Emits a Provenance Event of type FORK that establishes that the given parent was split into multiple child FlowFiles.
void	ProvenanceReporter.fork(FlowFile parent, Collection<FlowFile> children, String details)	Emits a Provenance Event of type FORK that establishes that the given parent was split into multiple child FlowFiles.
void	ProvenanceReporter.fork(FlowFile parent, Collection<FlowFile> children, String details, long forkDuration)	Emits a Provenance Event of type FORK that establishes that the given parent was split into multiple child FlowFiles.
ProvenanceEventBuilder	ProvenanceEventBuilder.fromFlowFile(FlowFile flowFile)	Populates the builder with as much information as it can from the given FlowFile
void	ProvenanceReporter.invokeRemoteProcess(FlowFile flowFile, String transitUri)	Emits a Provenance Event of type ProvenanceEventType.REMOTE_INVOCATION that indicates a remote invocation is requested to an external endpoint using the given FlowFile.
void	ProvenanceReporter.invokeRemoteProcess(FlowFile flowFile, String transitUri, String details)	Emits a Provenance Event of type ProvenanceEventType.REMOTE_INVOCATION that indicates a remote invocation is requested to an external endpoint using the given FlowFile.
void	ProvenanceReporter.join(Collection<FlowFile> parents, FlowFile child)	Emits a Provenance Event of type JOIN that establishes that the given parents were joined together to create a new child FlowFile.
void	ProvenanceReporter.join(Collection<FlowFile> parents, FlowFile child, long joinDuration)	Emits a Provenance Event of type JOIN that establishes that the given parents were joined together to create a new child FlowFile.
void	ProvenanceReporter.join(Collection<FlowFile> parents, FlowFile child, String details)	Emits a Provenance Event of type JOIN that establishes that the given parents were joined together to create a new child FlowFile.
void	ProvenanceReporter.join(Collection<FlowFile> parents, FlowFile child, String details, long joinDuration)	Emits a Provenance Event of type JOIN that establishes that the given parents were joined together to create a new child FlowFile.
void	ProvenanceReporter.modifyAttributes(FlowFile flowFile)	Emits a Provenance Event of type ATTRIBUTES_MODIFIED that indicates that the Attributes of the given FlowFile were updated.
void	ProvenanceReporter.modifyAttributes(FlowFile flowFile, String details)	Emits a Provenance Event of type ATTRIBUTES_MODIFIED that indicates that the Attributes of the given FlowFile were updated.
void	ProvenanceReporter.modifyContent(FlowFile flowFile)	Emits a Provenance Event of type CONTENT_MODIFIED that indicates that the content of the given FlowFile has been modified.
void	ProvenanceReporter.modifyContent(FlowFile flowFile, long processingMillis)	Emits a Provenance Event of type CONTENT_MODIFIED that indicates that the content of the given FlowFile has been modified.
void	ProvenanceReporter.modifyContent(FlowFile flowFile, String details)	Emits a Provenance Event of type CONTENT_MODIFIED that indicates that the content of the given FlowFile has been modified.
void	ProvenanceReporter.modifyContent(FlowFile flowFile, String details, long processingMillis)	Emits a Provenance Event of type CONTENT_MODIFIED that indicates that the content of the given FlowFile has been modified.
void	ProvenanceReporter.receive(FlowFile flowFile, String transitUri)	Emits a Provenance Event of type RECEIVE that indicates that the given FlowFile was created from data received from an external source.
void	ProvenanceReporter.receive(FlowFile flowFile, String transitUri, long transmissionMillis)	Emits a Provenance Event of type RECEIVE that indicates that the given FlowFile was created from data received from an external source.
void	ProvenanceReporter.receive(FlowFile flowFile, String transitUri, String sourceSystemFlowFileIdentifier)	Emits a Provenance Event of type RECEIVE that indicates that the given FlowFile was created from data received from the specified URI and that the source system used the specified identifier (a URI with namespace) to refer to the data.
void	ProvenanceReporter.receive(FlowFile flowFile, String transitUri, String details, long transmissionMillis)	Emits a Provenance Event of type RECEIVE that indicates that the given FlowFile was created from data received from an external source and provides additional details about the receipt of the FlowFile, such as a remote system's Distinguished Name.
void	ProvenanceReporter.receive(FlowFile flowFile, String transitUri, String sourceSystemFlowFileIdentifier, String details, long transmissionMillis)	Emits a Provenance Event of type RECEIVE that indicates that the given FlowFile was created from data received from an external source and provides additional details about the receipt of the FlowFile, such as a remote system's Distinguished Name.
ProvenanceEventBuilder	ProvenanceEventBuilder.removeChildFlowFile(FlowFile child)	Removes the given FlowFile as a child for Events of type ProvenanceEventType.FORK, ProvenanceEventType.JOIN, and ProvenanceEventType.CLONE This is valid only for ProvenanceEventType.FORK, ProvenanceEventType.JOIN, and ProvenanceEventType.CLONE events and will be ignored for any other event types.
ProvenanceEventBuilder	ProvenanceEventBuilder.removeParentFlowFile(FlowFile parent)	Removes the given FlowFile as a parent for Events of type, ProvenanceEventType.FORK, ProvenanceEventType.JOIN, and ProvenanceEventType.CLONE This is valid only for ProvenanceEventType.FORK, ProvenanceEventType.JOIN, and ProvenanceEventType.CLONE events and will be ignored for any other event types.
void	ProvenanceReporter.route(FlowFile flowFile, Relationship relationship)	Emits a Provenance Event of type ROUTE that indicates that the given FlowFile was routed to the given Relationship.
void	ProvenanceReporter.route(FlowFile flowFile, Relationship relationship, long processingDuration)	Emits a Provenance Event of type ROUTE that indicates that the given FlowFile was routed to the given Relationship.
void	ProvenanceReporter.route(FlowFile flowFile, Relationship relationship, String details)	Emits a Provenance Event of type ROUTE that indicates that the given FlowFile was routed to the given Relationship.
void	ProvenanceReporter.route(FlowFile flowFile, Relationship relationship, String details, long processingDuration)	Emits a Provenance Event of type ROUTE that indicates that the given FlowFile was routed to the given Relationship.
void	ProvenanceReporter.send(FlowFile flowFile, String transitUri)	Emits a Provenance Event of type SEND that indicates that a copy of the given FlowFile was sent to an external destination.
void	ProvenanceReporter.send(FlowFile flowFile, String transitUri, boolean force)	Emits a Provenance Event of type SEND that indicates that a copy of the given FlowFile was sent to an external destination.
void	ProvenanceReporter.send(FlowFile flowFile, String transitUri, long transmissionMillis)	Emits a Provenance Event of type SEND that indicates that a copy of the given FlowFile was sent to an external destination.
void	ProvenanceReporter.send(FlowFile flowFile, String transitUri, long transmissionMillis, boolean force)	Emits a Provenance Event of type SEND that indicates that a copy of the given FlowFile was sent to an external destination.
void	ProvenanceReporter.send(FlowFile flowFile, String transitUri, String details)	Emits a Provenance Event of type SEND that indicates that a copy of the given FlowFile was sent to an external destination.
void	ProvenanceReporter.send(FlowFile flowFile, String transitUri, String details, boolean force)	Emits a Provenance Event of type SEND that indicates that a copy of the given FlowFile was sent to an external destination.
void	ProvenanceReporter.send(FlowFile flowFile, String transitUri, String details, long transmissionMillis)	Emits a Provenance Event of type SEND that indicates that a copy of the given FlowFile was sent to an external destination.
void	ProvenanceReporter.send(FlowFile flowFile, String transitUri, String details, long transmissionMillis, boolean force)	Emits a Provenance Event of type SEND that indicates that a copy of the given FlowFile was sent to an external destination.
void	ProvenanceReporter.upload(FlowFile flowFile, long size, String transitUri)	Emits a Provenance Event of type UPLOAD that indicates that an external resource was sent to an external destination.
void	ProvenanceReporter.upload(FlowFile flowFile, long size, String transitUri, String details, long transmissionMillis, boolean force)	Emits a Provenance Event of type UPLOAD that indicates that an external resource was sent to an external destination.

Method parameters in org.apache.nifi.provenance with type arguments of type FlowFile

Modifier and Type	Method	Description
void	ProvenanceReporter.fork(FlowFile parent, Collection<FlowFile> children)	Emits a Provenance Event of type FORK that establishes that the given parent was split into multiple child FlowFiles.
void	ProvenanceReporter.fork(FlowFile parent, Collection<FlowFile> children, long forkDuration)	Emits a Provenance Event of type FORK that establishes that the given parent was split into multiple child FlowFiles.
void	ProvenanceReporter.fork(FlowFile parent, Collection<FlowFile> children, String details)	Emits a Provenance Event of type FORK that establishes that the given parent was split into multiple child FlowFiles.
void	ProvenanceReporter.fork(FlowFile parent, Collection<FlowFile> children, String details, long forkDuration)	Emits a Provenance Event of type FORK that establishes that the given parent was split into multiple child FlowFiles.
void	ProvenanceReporter.join(Collection<FlowFile> parents, FlowFile child)	Emits a Provenance Event of type JOIN that establishes that the given parents were joined together to create a new child FlowFile.
void	ProvenanceReporter.join(Collection<FlowFile> parents, FlowFile child, long joinDuration)	Emits a Provenance Event of type JOIN that establishes that the given parents were joined together to create a new child FlowFile.
void	ProvenanceReporter.join(Collection<FlowFile> parents, FlowFile child, String details)	Emits a Provenance Event of type JOIN that establishes that the given parents were joined together to create a new child FlowFile.
void	ProvenanceReporter.join(Collection<FlowFile> parents, FlowFile child, String details, long joinDuration)	Emits a Provenance Event of type JOIN that establishes that the given parents were joined together to create a new child FlowFile.