| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchBoxFile</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;">FetchBoxFile</h1><h2>Description: </h2><p>Fetches files from a Box Folder. Designed to be used in tandem with ListBoxFile.</p><h3>Tags: </h3><p>box, storage, fetch</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>Box Client Service</strong></td><td>box-client-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>BoxClientService<br/><strong>Implementation: </strong><a href="../../../nifi-box-services-nar/1.19.1/org.apache.nifi.box.controllerservices.JsonConfigBasedBoxClientService/index.html">JsonConfigBasedBoxClientService</a></td><td id="description">Controller Service used to obtain a Box API connection.</td></tr><tr><td id="name"><strong>File ID</strong></td><td>box-file-id</td><td id="default-value">${box.id}</td><td id="allowable-values"></td><td id="description">The ID of the File to fetch<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>A FlowFile will be routed here for each successfully fetched File.</td></tr><tr><td>failure</td><td>A FlowFile will be routed here for each File for which fetch was attempted but failed.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>error.code</td><td>The error code returned by Box when the fetch of a file fails</td></tr><tr><td>error.message</td><td>The error message returned by Box when the fetch of a file fails</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<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.box.ListBoxFile/index.html">ListBoxFile</a></p></body></html> |