Uses of Interface
org.apache.nifi.flowfile.FlowFile
Packages that use FlowFile
Package
Description
-
Uses of FlowFile in org.apache.nifi.components
Methods in org.apache.nifi.components with parameters of type FlowFileModifier and TypeMethodDescriptionPropertyValue.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.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.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.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.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 FlowFileModifier and TypeMethodDescriptionEvaluates the expression providing access to additional variables including the flow file properties such as file size, identifier, etc..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 FlowFileModifier and TypeMethodDescriptionProcessSession.append
(FlowFile source, OutputStreamCallback writer) Executes the given {code writer}OutputStreamCallback
against the content of the givenFlowFile
, such that any data written to the OutputStream will be appended to the end of FlowFile's content.Creates a newFlowFile
with a parent linkage to theexample
FlowFile.Creates a newFlowFile
with a parent linkage to theparent
FlowFile.ProcessSession.create()
Creates a newFlowFile
in the repository with no content and without any linkage to a parent FlowFile.ProcessSession.create
(Collection<FlowFile> parents) Creates a newFlowFile
in the repository with no content but with a parent linkage to allparents
.Creates a newFlowFile
in the repository with no content but with a parent linkage to theparent
.ProcessSession.get()
Returns theFlowFile
from the work queue that is next highest priority to process.ProcessSession.importFrom
(InputStream source, FlowFile destination) ProcessSession.importFrom
(Path source, boolean keepSourceFile, FlowFile destination) ProcessSession.merge
(Collection<FlowFile> sources, FlowFile destination) Combines the content of all givensources
FlowFile
s into a single given destination FlowFile.ProcessSession.merge
(Collection<FlowFile> sources, FlowFile destination, byte[] header, byte[] footer, byte[] demarcator) Combines the content of all givensources
FlowFile
s into a single given destination FlowFile.Sets a penalty for the givenFlowFile
, which will make it unavailable to be operated on any further during the penalty period.ProcessSession.putAllAttributes
(FlowFile flowFile, Map<String, String> attributes) ProcessSession.putAttribute
(FlowFile flowFile, String key, String value) ProcessSession.removeAllAttributes
(FlowFile flowFile, Pattern keyPattern) Removes all attributes from the givenFlowFile
whose key matches the given pattern.ProcessSession.removeAllAttributes
(FlowFile flowFile, Set<String> keys) Removes the attributes with the givenkeys
from the givenFlowFile
.ProcessSession.removeAttribute
(FlowFile flowFile, String key) Removes the attribute with the givenkey
from the givenFlowFile
.ProcessSession.write
(FlowFile source, OutputStreamCallback writer) Executes the given {code writer}OutputStreamCallback
against the content of the givenFlowFile
.ProcessSession.write
(FlowFile source, StreamCallback writer) Executes the given {code writer}StreamCallback
against the content of the givenFlowFile
.Methods in org.apache.nifi.processor that return types with arguments of type FlowFileModifier and TypeMethodDescriptionProcessSession.get
(int maxResults) Returns the next up tomaxResults
FlowFile
s from the work queue that are the highest priority to process.ProcessSession.get
(FlowFileFilter filter) Returns allFlowFile
s from all the incoming queues which the givenFlowFileFilter
accepts.Methods in org.apache.nifi.processor with parameters of type FlowFileModifier and TypeMethodDescriptionProcessSession.append
(FlowFile source, OutputStreamCallback writer) Executes the given {code writer}OutputStreamCallback
against the content of the givenFlowFile
, such that any data written to the OutputStream will be appended to the end of FlowFile's content.Creates a newFlowFile
with a parent linkage to theexample
FlowFile.Creates a newFlowFile
with a parent linkage to theparent
FlowFile.Creates a newFlowFile
in the repository with no content but with a parent linkage to theparent
.void
ProcessSession.exportTo
(FlowFile flowFile, OutputStream destination) void
Indicates whether or not the given FlowFile should be selected and whether or not the Processor is interested in filtering additional FlowFilesProcessSession.importFrom
(InputStream source, FlowFile destination) ProcessSession.importFrom
(Path source, boolean keepSourceFile, FlowFile destination) ProcessSession.merge
(Collection<FlowFile> sources, FlowFile destination) Combines the content of all givensources
FlowFile
s into a single given destination FlowFile.ProcessSession.merge
(Collection<FlowFile> sources, FlowFile destination, byte[] header, byte[] footer, byte[] demarcator) Combines the content of all givensources
FlowFile
s into a single given destination FlowFile.Sets a penalty for the givenFlowFile
, which will make it unavailable to be operated on any further during the penalty period.ProcessSession.putAllAttributes
(FlowFile flowFile, Map<String, String> attributes) ProcessSession.putAttribute
(FlowFile flowFile, String key, String value) Provides anInputStream
that can be used to read the content of the givenFlowFile
.void
ProcessSession.read
(FlowFile source, InputStreamCallback reader) Executes the given {code reader}InputStreamCallback
against the content of the givenFlowFile
.void
Ends the managed persistence for the givenFlowFile
.ProcessSession.removeAllAttributes
(FlowFile flowFile, Pattern keyPattern) Removes all attributes from the givenFlowFile
whose key matches the given pattern.ProcessSession.removeAllAttributes
(FlowFile flowFile, Set<String> keys) Removes the attributes with the givenkeys
from the givenFlowFile
.ProcessSession.removeAttribute
(FlowFile flowFile, String key) Removes the attribute with the givenkey
from the givenFlowFile
.void
Transfers the givenFlowFile
back to the work queue from which it was pulled.void
ProcessSession.transfer
(FlowFile flowFile, Relationship relationship) Transfers the givenFlowFile
to the appropriate destination processor work queue(s) based on the givenrelationship
.Provides anOutputStream
that can be used to write the content of the givenFlowFile
.ProcessSession.write
(FlowFile source, OutputStreamCallback writer) Executes the given {code writer}OutputStreamCallback
against the content of the givenFlowFile
.ProcessSession.write
(FlowFile source, StreamCallback writer) Executes the given {code writer}StreamCallback
against the content of the givenFlowFile
.Method parameters in org.apache.nifi.processor with type arguments of type FlowFileModifier and TypeMethodDescriptionProcessSession.create
(Collection<FlowFile> parents) Creates a newFlowFile
in the repository with no content but with a parent linkage to allparents
.ProcessSession.merge
(Collection<FlowFile> sources, FlowFile destination) Combines the content of all givensources
FlowFile
s into a single given destination FlowFile.ProcessSession.merge
(Collection<FlowFile> sources, FlowFile destination, byte[] header, byte[] footer, byte[] demarcator) Combines the content of all givensources
FlowFile
s into a single given destination FlowFile.void
ProcessSession.migrate
(ProcessSession newOwner, Collection<FlowFile> flowFiles) Migrates ownership of the givenflowFiles
FlowFile
s fromthis
session to the givennewOwner
ProcessSession
.void
ProcessSession.remove
(Collection<FlowFile> flowFiles) Ends the managed persistence for the givenFlowFile
s.void
ProcessSession.transfer
(Collection<FlowFile> flowFiles) Transfers the givenFlowFile
s back to the work queues from which the FlowFiles were pulled.void
ProcessSession.transfer
(Collection<FlowFile> flowFiles, Relationship relationship) Transfers the givenFlowFile
s to the appropriate destination processor work queue(s) based on the givenrelationship
. -
Uses of FlowFile in org.apache.nifi.provenance
Methods in org.apache.nifi.provenance with parameters of type FlowFileModifier and TypeMethodDescriptionProvenanceEventBuilder.addChildFlowFile
(FlowFile child) Adds the given FlowFile as a child for Events of typeProvenanceEventType.FORK
,ProvenanceEventType.JOIN
, andProvenanceEventType.CLONE
This is valid only forProvenanceEventType.FORK
,ProvenanceEventType.JOIN
, andProvenanceEventType.CLONE
events and will be ignored for any other event types.ProvenanceEventBuilder.addParentFlowFile
(FlowFile parent) Adds the given FlowFile as a parent for Events of type,ProvenanceEventType.FORK
,ProvenanceEventType.JOIN
, andProvenanceEventType.CLONE
This is valid only forProvenanceEventType.FORK
,ProvenanceEventType.JOIN
, andProvenanceEventType.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 typeADDINFO
that provides a linkage between the given FlowFile and alternate identifier.void
Emits a Provenance Event of typeCLONE
that establishes that the given child is an exact replica of the parent.void
Emits a Provenance Event of typeCREATE
that indicates that the given FlowFile was created by NiFi from data that was not received from an external entity.void
Emits a Provenance Event of typeCREATE
that indicates that the given FlowFile was created by NiFi from data that was not received from an external entity.void
Emits a Provenance Event of typeFETCH
that indicates that the content of the given FlowFile was overwritten with the data received from an external source.void
Emits a Provenance Event of typeFETCH
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 typeFETCH
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 typeFORK
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 typeFORK
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 typeFORK
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 typeFORK
that establishes that the given parent was split into multiple child FlowFiles.ProvenanceEventBuilder.fromFlowFile
(FlowFile flowFile) Populates the builder with as much information as it can from the given FlowFilevoid
ProvenanceReporter.invokeRemoteProcess
(FlowFile flowFile, String transitUri) Emits a Provenance Event of typeProvenanceEventType.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 typeProvenanceEventType.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 typeJOIN
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 typeJOIN
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 typeJOIN
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 typeJOIN
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 typeATTRIBUTES_MODIFIED
that indicates that the Attributes of the given FlowFile were updated.void
ProvenanceReporter.modifyAttributes
(FlowFile flowFile, String details) Emits a Provenance Event of typeATTRIBUTES_MODIFIED
that indicates that the Attributes of the given FlowFile were updated.void
ProvenanceReporter.modifyContent
(FlowFile flowFile) Emits a Provenance Event of typeCONTENT_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 typeCONTENT_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 typeCONTENT_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 typeCONTENT_MODIFIED
that indicates that the content of the given FlowFile has been modified.void
Emits a Provenance Event of typeRECEIVE
that indicates that the given FlowFile was created from data received from an external source.void
Emits a Provenance Event of typeRECEIVE
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 typeRECEIVE
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 typeRECEIVE
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 typeRECEIVE
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.removeChildFlowFile
(FlowFile child) Removes the given FlowFile as a child for Events of typeProvenanceEventType.FORK
,ProvenanceEventType.JOIN
, andProvenanceEventType.CLONE
This is valid only forProvenanceEventType.FORK
,ProvenanceEventType.JOIN
, andProvenanceEventType.CLONE
events and will be ignored for any other event types.ProvenanceEventBuilder.removeParentFlowFile
(FlowFile parent) Removes the given FlowFile as a parent for Events of type,ProvenanceEventType.FORK
,ProvenanceEventType.JOIN
, andProvenanceEventType.CLONE
This is valid only forProvenanceEventType.FORK
,ProvenanceEventType.JOIN
, andProvenanceEventType.CLONE
events and will be ignored for any other event types.void
ProvenanceReporter.route
(FlowFile flowFile, Relationship relationship) Emits a Provenance Event of typeROUTE
that indicates that the given FlowFile was routed to the givenRelationship
.void
ProvenanceReporter.route
(FlowFile flowFile, Relationship relationship, long processingDuration) Emits a Provenance Event of typeROUTE
that indicates that the given FlowFile was routed to the givenRelationship
.void
ProvenanceReporter.route
(FlowFile flowFile, Relationship relationship, String details) Emits a Provenance Event of typeROUTE
that indicates that the given FlowFile was routed to the givenRelationship
.void
ProvenanceReporter.route
(FlowFile flowFile, Relationship relationship, String details, long processingDuration) Emits a Provenance Event of typeROUTE
that indicates that the given FlowFile was routed to the givenRelationship
.void
Emits a Provenance Event of typeSEND
that indicates that a copy of the given FlowFile was sent to an external destination.void
Emits a Provenance Event of typeSEND
that indicates that a copy of the given FlowFile was sent to an external destination.void
Emits a Provenance Event of typeSEND
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 typeSEND
that indicates that a copy of the given FlowFile was sent to an external destination.void
Emits a Provenance Event of typeSEND
that indicates that a copy of the given FlowFile was sent to an external destination.void
Emits a Provenance Event of typeSEND
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 typeSEND
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 typeSEND
that indicates that a copy of the given FlowFile was sent to an external destination.void
Emits a Provenance Event of typeUPLOAD
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 typeUPLOAD
that indicates that an external resource was sent to an external destination.Method parameters in org.apache.nifi.provenance with type arguments of type FlowFileModifier and TypeMethodDescriptionvoid
ProvenanceReporter.fork
(FlowFile parent, Collection<FlowFile> children) Emits a Provenance Event of typeFORK
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 typeFORK
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 typeFORK
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 typeFORK
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 typeJOIN
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 typeJOIN
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 typeJOIN
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 typeJOIN
that establishes that the given parents were joined together to create a new child FlowFile.