| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutFile</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutFile</h1><h2>Description: </h2><p>Writes the contents of a FlowFile to the local file system</p><h3>Tags: </h3><p>put, local, copy, archive, files, filesystem</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Directory</strong></td><td>Directory</td><td></td><td id="allowable-values"></td><td id="description">The directory to which files should be written. You may use expression language such as /aa/bb/${path}<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Conflict Resolution Strategy</strong></td><td>Conflict Resolution Strategy</td><td id="default-value">fail</td><td id="allowable-values"><ul><li>replace</li><li>ignore</li><li>fail</li></ul></td><td id="description">Indicates what should happen when a file with the same name already exists in the output directory</td></tr><tr><td id="name"><strong>Create Missing Directories</strong></td><td>Create Missing Directories</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, then missing destination directories will be created. If false, flowfiles are penalized and sent to failure.</td></tr><tr><td id="name">Maximum File Count</td><td>Maximum File Count</td><td></td><td id="allowable-values"></td><td id="description">Specifies the maximum number of files that can exist in the output directory</td></tr><tr><td id="name">Last Modified Time</td><td>Last Modified Time</td><td></td><td id="allowable-values"></td><td id="description">Sets the lastModifiedTime on the output file to the value of this attribute. Format must be yyyy-MM-dd'T'HH:mm:ssZ. You may also use expression language such as ${file.lastModifiedTime}.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Permissions</td><td>Permissions</td><td></td><td id="allowable-values"></td><td id="description">Sets the permissions on the output file to the value of this attribute. Format must be either UNIX rwxrwxrwx with a - in place of denied permissions (e.g. rw-r--r--) or an octal number (e.g. 644). You may also use expression language such as ${file.permissions}.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Owner</td><td>Owner</td><td></td><td id="allowable-values"></td><td id="description">Sets the owner on the output file to the value of this attribute. You may also use expression language such as ${file.owner}. Note on many operating systems Nifi must be running as a super-user to have the permissions to set the file owner.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Group</td><td>Group</td><td></td><td id="allowable-values"></td><td id="description">Sets the group on the output file to the value of this attribute. You may also use expression language such as ${file.group}.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Files that have been successfully written to the output directory are transferred to this relationship</td></tr><tr><td>failure</td><td>Files that could not be written to the output directory for some reason are transferred to this relationship</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The filename to use when writing the FlowFile to disk.</td></tr></table><h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>write filesystem</td><td>Provides operator the ability to write to any file that NiFi has access to.</td></tr></table><h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.FetchFile/index.html">FetchFile</a>, <a href="../org.apache.nifi.processors.standard.GetFile/index.html">GetFile</a></p></body></html> |