FileParameterProvider

Description:

Fetches parameters from files. Parameter groups are indicated by a set of directories, and files within the directories map to parameter names. The content of the file becomes the parameter value.

Additional Details...

Tags:

file

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Parameter Group Directoriesparameter-group-directoriesA comma-separated list of directory absolute paths that will map to named parameter groups. Each directory that contains files will map to a parameter group, named after the innermost directory in the path. Files inside the directory will map to parameter names, whose values are the content of each respective file.
Parameter Value Byte Limitparameter-value-byte-limit256 BThe maximum byte size of a parameter value. Since parameter values are pulled from the contents of files, this is a safeguard that can prevent memory issues if large files are included.
Parameter Value Encodingparameter-value-encodingBase64
  • Base64 File content is Base64-encoded, and will be decoded before providing the value as a Parameter.
  • Plain text File content is not encoded, and will be provided directly as a Parameter value.
Indicates how parameter values are encoded inside Parameter files.

State management:

This component does not store state.

Restricted:

Required PermissionExplanation
read filesystemProvides operator the ability to read from any file that NiFi has access to.

System Resource Considerations:

None specified.