ListFile

ListFile 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: Retrieves a listing of files from the input directory. For each file listed, creates a FlowFile that represents the file so that it can be fetched in conjunction with FetchFile. This Processor is designed to run on Primary Node only in a cluster when 'Input Directory Location' is set to 'Remote'. If the primary node changes, the new Primary Node will pick up where the previous node left off without duplicating all the data. When 'Input Directory Location' is 'Local', the 'Execution' mode can be anything, and synchronization won't happen. Unlike GetFile, this Processor does not delete any data from the local filesystem.
Tags: file, filesystem, get, ingest, list, source
Input Requirement: FORBIDDEN
Supports Sensitive Dynamic Properties: false

Properties

Entity Tracking Initial Listing Target
Specify how initial listing should be handled. Used by 'Tracking Entities' strategy.
Display Name

Entity Tracking Initial Listing Target

Description

Specify how initial listing should be handled. Used by 'Tracking Entities' strategy.

API Name

et-initial-listing-target

Default Value

all

Allowable Values
- Tracking Time Window
- All Available
Expression Language Scope

Not Supported

Sensitive

false

Required

false
Entity Tracking Node Identifier
The configured value will be appended to the cache key so that listing state can be tracked per NiFi node rather than cluster wide when tracking state is scoped to LOCAL. Used by 'Tracking Entities' strategy.

Display Name

Entity Tracking Node Identifier

Description

The configured value will be appended to the cache key so that listing state can be tracked per NiFi node rather than cluster wide when tracking state is scoped to LOCAL. Used by 'Tracking Entities' strategy.

API Name

et-node-identifier

Default Value

${hostname()}

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Entity Tracking State Cache
Listed entities are stored in the specified cache storage so that this processor can resume listing across NiFi restart or in case of primary node change. 'Tracking Entities' strategy require tracking information of all listed entities within the last 'Tracking Time Window'. To support large number of entities, the strategy uses DistributedMapCache instead of managed state. Cache key format is 'ListedEntities::{processorId}(::{nodeId})'. If it tracks per node listed entities, then the optional '::{nodeId}' part is added to manage state separately. E.g. cluster wide cache key = 'ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b', per node cache key = 'ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b::nifi-node3' The stored cache content is Gzipped JSON string. The cache key will be deleted when target listing configuration is changed. Used by 'Tracking Entities' strategy.

Display Name

Entity Tracking State Cache

Description

Listed entities are stored in the specified cache storage so that this processor can resume listing across NiFi restart or in case of primary node change. 'Tracking Entities' strategy require tracking information of all listed entities within the last 'Tracking Time Window'. To support large number of entities, the strategy uses DistributedMapCache instead of managed state. Cache key format is 'ListedEntities::{processorId}(::{nodeId})'. If it tracks per node listed entities, then the optional '::{nodeId}' part is added to manage state separately. E.g. cluster wide cache key = 'ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b', per node cache key = 'ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b::nifi-node3' The stored cache content is Gzipped JSON string. The cache key will be deleted when target listing configuration is changed. Used by 'Tracking Entities' strategy.

API Name

et-state-cache

Service Interface

org.apache.nifi.distributed.cache.client.DistributedMapCacheClient

Service Implementations

org.apache.nifi.hazelcast.services.cacheclient.HazelcastMapCacheClient

org.apache.nifi.distributed.cache.client.MapCacheClientService

org.apache.nifi.redis.service.RedisDistributedMapCacheClientService

org.apache.nifi.redis.service.SimpleRedisDistributedMapCacheClientService

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Entity Tracking Time Window
Specify how long this processor should track already-listed entities. 'Tracking Entities' strategy can pick any entity whose timestamp is inside the specified time window. For example, if set to '30 minutes', any entity having timestamp in recent 30 minutes will be the listing target when this processor runs. A listed entity is considered 'new/updated' and a FlowFile is emitted if one of following condition meets: 1. does not exist in the already-listed entities, 2. has newer timestamp than the cached entity, 3. has different size than the cached entity. If a cached entity's timestamp becomes older than specified time window, that entity will be removed from the cached already-listed entities. Used by 'Tracking Entities' strategy.

Display Name

Entity Tracking Time Window

Description

Specify how long this processor should track already-listed entities. 'Tracking Entities' strategy can pick any entity whose timestamp is inside the specified time window. For example, if set to '30 minutes', any entity having timestamp in recent 30 minutes will be the listing target when this processor runs. A listed entity is considered 'new/updated' and a FlowFile is emitted if one of following condition meets: 1. does not exist in the already-listed entities, 2. has newer timestamp than the cached entity, 3. has different size than the cached entity. If a cached entity's timestamp becomes older than specified time window, that entity will be removed from the cached already-listed entities. Used by 'Tracking Entities' strategy.

API Name

et-time-window

Default Value

3 hours

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
File Filter
Only files whose names match the given regular expression will be picked up

Display Name

File Filter

Description

Only files whose names match the given regular expression will be picked up

API Name

File Filter

Default Value

[^\.].*

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Ignore Hidden Files
Indicates whether or not hidden files should be ignored
Display Name

Ignore Hidden Files

Description

Indicates whether or not hidden files should be ignored

API Name

Ignore Hidden Files

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Include File Attributes
Whether or not to include information such as the file's Last Modified Time and Owner as FlowFile Attributes. Depending on the File System being used, gathering this information can be expensive and as a result should be disabled. This is especially true of remote file shares.
Display Name

Include File Attributes

Description

Whether or not to include information such as the file's Last Modified Time and Owner as FlowFile Attributes. Depending on the File System being used, gathering this information can be expensive and as a result should be disabled. This is especially true of remote file shares.

API Name

Include File Attributes

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Input Directory
The input directory from which files to pull files

Display Name

Input Directory

Description

The input directory from which files to pull files

API Name

Input Directory

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Input Directory Location
Specifies where the Input Directory is located. This is used to determine whether state should be stored locally or across the cluster.
Display Name

Input Directory Location

Description

Specifies where the Input Directory is located. This is used to determine whether state should be stored locally or across the cluster.

API Name

Input Directory Location

Default Value

Local

Allowable Values
- Local
- Remote
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Listing Strategy
Specify how to determine new/updated entities. See each strategy descriptions for detail.
Display Name

Listing Strategy

Description

Specify how to determine new/updated entities. See each strategy descriptions for detail.

API Name

listing-strategy

Default Value

timestamps

Allowable Values
- Tracking Timestamps
- Tracking Entities
- No Tracking
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Max Directory Listing Time
The maximum amount of time that listing any single directory is expected to take. If the listing for the directory specified by the 'Input Directory' property, or the listing of any subdirectory (if 'Recurse' is set to true) takes longer than this amount of time, a warning bulletin will be generated for each directory listing that exceeds this amount of time.

Display Name

Max Directory Listing Time

Description

The maximum amount of time that listing any single directory is expected to take. If the listing for the directory specified by the 'Input Directory' property, or the listing of any subdirectory (if 'Recurse' is set to true) takes longer than this amount of time, a warning bulletin will be generated for each directory listing that exceeds this amount of time.

API Name

max-listing-time

Default Value

3 mins

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Max Disk Operation Time
The maximum amount of time that any single disk operation is expected to take. If any disk operation takes longer than this amount of time, a warning bulletin will be generated for each operation that exceeds this amount of time.

Display Name

Max Disk Operation Time

Description

The maximum amount of time that any single disk operation is expected to take. If any disk operation takes longer than this amount of time, a warning bulletin will be generated for each operation that exceeds this amount of time.

API Name

max-operation-time

Default Value

10 secs

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Maximum Number of Files to Track
If the 'Track Performance' property is set to 'true', this property indicates the maximum number of files whose performance metrics should be held onto. A smaller value for this property will result in less heap utilization, while a larger value may provide more accurate insights into how the disk access operations are performing

Display Name

Maximum Number of Files to Track

Description

If the 'Track Performance' property is set to 'true', this property indicates the maximum number of files whose performance metrics should be held onto. A smaller value for this property will result in less heap utilization, while a larger value may provide more accurate insights into how the disk access operations are performing

API Name

max-performance-metrics

Default Value

100000

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Maximum File Age
The maximum age that a file must be in order to be pulled; any file older than this amount of time (according to last modification date) will be ignored

Display Name

Maximum File Age

Description

The maximum age that a file must be in order to be pulled; any file older than this amount of time (according to last modification date) will be ignored

API Name

Maximum File Age

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Maximum File Size
The maximum size that a file can be in order to be pulled

Display Name

Maximum File Size

Description

The maximum size that a file can be in order to be pulled

API Name

Maximum File Size

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Minimum File Age
The minimum age that a file must be in order to be pulled; any file younger than this amount of time (according to last modification date) will be ignored

Display Name

Minimum File Age

Description

The minimum age that a file must be in order to be pulled; any file younger than this amount of time (according to last modification date) will be ignored

API Name

Minimum File Age

Default Value

0 sec

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Minimum File Size
The minimum size that a file must be in order to be pulled

Display Name

Minimum File Size

Description

The minimum size that a file must be in order to be pulled

API Name

Minimum File Size

Default Value

0 B

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Path Filter
When Recurse Subdirectories is true, then only subdirectories whose path matches the given regular expression will be scanned

Display Name

Path Filter

Description

When Recurse Subdirectories is true, then only subdirectories whose path matches the given regular expression will be scanned

API Name

Path Filter

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Record Writer
Specifies the Record Writer to use for creating the listing. If not specified, one FlowFile will be created for each entity that is listed. If the Record Writer is specified, all entities will be written to a single FlowFile instead of adding attributes to individual FlowFiles.

Display Name

Record Writer

Description

Specifies the Record Writer to use for creating the listing. If not specified, one FlowFile will be created for each entity that is listed. If the Record Writer is specified, all entities will be written to a single FlowFile instead of adding attributes to individual FlowFiles.

API Name

record-writer

Service Interface

org.apache.nifi.serialization.RecordSetWriterFactory

Service Implementations

org.apache.nifi.avro.AvroRecordSetWriter

org.apache.nifi.csv.CSVRecordSetWriter

org.apache.nifi.text.FreeFormTextRecordSetWriter

org.apache.nifi.json.JsonRecordSetWriter

org.apache.nifi.lookup.RecordSetWriterLookup

org.apache.nifi.record.script.ScriptedRecordSetWriter

org.apache.nifi.xml.XMLRecordSetWriter

Expression Language Scope

Not Supported

Sensitive

false

Required

false
Recurse Subdirectories
Indicates whether to list files from subdirectories of the directory
Display Name

Recurse Subdirectories

Description

Indicates whether to list files from subdirectories of the directory

API Name

Recurse Subdirectories

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Target System Timestamp Precision
Specify timestamp precision at the target system. Since this processor uses timestamp of entities to decide which should be listed, it is crucial to use the right timestamp precision.
Display Name

Target System Timestamp Precision

Description

Specify timestamp precision at the target system. Since this processor uses timestamp of entities to decide which should be listed, it is crucial to use the right timestamp precision.

API Name

target-system-timestamp-precision

Default Value

auto-detect

Allowable Values
- Auto Detect
- Milliseconds
- Seconds
- Minutes
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Track Performance
Whether or not the Processor should track the performance of disk access operations. If true, all accesses to disk will be recorded, including the file being accessed, the information being obtained, and how long it takes. This is then logged periodically at a DEBUG level. While the amount of data will be capped, this option may still consume a significant amount of heap (controlled by the 'Maximum Number of Files to Track' property), but it can be very useful for troubleshooting purposes if performance is poor is degraded.
Display Name

Track Performance

Description

Whether or not the Processor should track the performance of disk access operations. If true, all accesses to disk will be recorded, including the file being accessed, the information being obtained, and how long it takes. This is then logged periodically at a DEBUG level. While the amount of data will be capped, this option may still consume a significant amount of heap (controlled by the 'Maximum Number of Files to Track' property), but it can be very useful for troubleshooting purposes if performance is poor is degraded.

API Name

track-performance

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true

State Management

Scopes	Description
LOCAL, CLUSTER	After performing a listing of files, the timestamp of the newest file is stored. This allows the Processor to list only files that have been added or modified after this date the next time that the Processor is run. Whether the state is stored with a Local or Cluster scope depends on the value of the <Input Directory Location> property.

Relationships

Name	Description
success	All FlowFiles that are received are routed to success

Writes Attributes

Name	Description
filename	The name of the file that was read from filesystem.
path	The path is set to the relative path of the file's directory on filesystem compared to the Input Directory property. For example, if Input Directory is set to /tmp, then files picked up from /tmp will have the path attribute set to "/". If the Recurse Subdirectories property is set to true and a file is picked up from /tmp/abc/1/2/3, then the path attribute will be set to "abc/1/2/3/".
absolute.path	The absolute.path is set to the absolute path of the file's directory on filesystem. For example, if the Input Directory property is set to /tmp, then files picked up from /tmp will have the path attribute set to "/tmp/". If the Recurse Subdirectories property is set to true and a file is picked up from /tmp/abc/1/2/3, then the path attribute will be set to "/tmp/abc/1/2/3/".
file.owner	The user that owns the file in filesystem
file.group	The group that owns the file in filesystem
file.size	The number of bytes in the file in filesystem
file.permissions	The permissions for the file in filesystem. This is formatted as 3 characters for the owner, 3 for the group, and 3 for other users. For example rw-rw-r--
file.lastModifiedTime	The timestamp of when the file in filesystem was last modified as 'yyyy-MM-dd'T'HH:mm:ssZ'
file.lastAccessTime	The timestamp of when the file in filesystem was last accessed as 'yyyy-MM-dd'T'HH:mm:ssZ'
file.creationTime	The timestamp of when the file in filesystem was created as 'yyyy-MM-dd'T'HH:mm:ssZ'