GetFile

GetFile 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: Creates FlowFiles from files in a directory. NiFi will ignore files it doesn't have at least read permissions for.
Tags: files, filesystem, get, ingest, ingress, input, local, source
Input Requirement: FORBIDDEN
Supports Sensitive Dynamic Properties: false

Properties

Batch Size
The maximum number of files to pull in each invocation of the processor

Display Name

Batch Size

Description

The maximum number of files to pull in each invocation of the processor

API Name

Batch Size

Default Value

10

Expression Language Scope

Not Supported

Sensitive

false

Required

true
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
Input Directory
The input directory from which to pull files

Display Name

Input Directory

Description

The input directory from which to pull files

API Name

Input Directory

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Keep Source File
If true, the file is not deleted after it has been copied to the Content Repository; this causes the file to be picked up continually and is useful for testing purposes. If not keeping original NiFi will need write permissions on the directory it is pulling from otherwise it will ignore the file.
Display Name

Keep Source File

Description

If true, the file is not deleted after it has been copied to the Content Repository; this causes the file to be picked up continually and is useful for testing purposes. If not keeping original NiFi will need write permissions on the directory it is pulling from otherwise it will ignore the file.

API Name

Keep Source File

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

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
Polling Interval
Indicates how long to wait before performing a directory listing

Display Name

Polling Interval

Description

Indicates how long to wait before performing a directory listing

API Name

Polling Interval

Default Value

0 sec

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Recurse Subdirectories
Indicates whether or not to pull files from subdirectories
Display Name

Recurse Subdirectories

Description

Indicates whether or not to pull files from subdirectories

API Name

Recurse Subdirectories

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Restrictions

Required Permission	Explanation
read filesystem	Provides operator the ability to read from any file that NiFi has access to.
write filesystem	Provides operator the ability to delete any file that NiFi has access to.

Relationships

Name	Description
success	All files are routed to success

Writes Attributes

Name	Description
filename	The filename is set to the name of the file on disk
path	The path is set to the relative path of the file's directory on disk. For example, if the <Input Directory> property is set to /tmp, 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
file.creationTime	The date and time that the file was created. May not work on all file systems
file.lastModifiedTime	The date and time that the file was last modified. May not work on all file systems
file.lastAccessTime	The date and time that the file was last accessed. May not work on all file systems
file.owner	The owner of the file. May not work on all file systems
file.group	The group owner of the file. May not work on all file systems
file.permissions	The read/write/execute permissions of the file. May not work on all file systems
absolute.path	The full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path