| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchAzureDataLakeStorage</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;">FetchAzureDataLakeStorage</h1><h2>Description: </h2><p>Fetch the provided file from Azure Data Lake Storage</p><h3>Tags: </h3><p>azure, microsoft, cloud, storage, adlsgen2, datalake</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>ADLS Credentials</strong></td><td>adls-credentials-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>ADLSCredentialsService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.services.azure.storage.ADLSCredentialsControllerService/index.html">ADLSCredentialsControllerService</a></td><td id="description">Controller Service used to obtain Azure Credentials.</td></tr><tr><td id="name"><strong>Filesystem Name</strong></td><td>filesystem-name</td><td></td><td id="allowable-values"></td><td id="description">Name of the Azure Storage File System (also called Container). It is assumed to be already existing.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Directory Name</strong></td><td>directory-name</td><td></td><td id="allowable-values"></td><td id="description">Name of the Azure Storage Directory. The Directory Name cannot contain a leading '/'. The root directory can be designated by the empty string value. In case of the PutAzureDataLakeStorage processor, the directory will be created if not already existing.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>File Name</strong></td><td>file-name</td><td id="default-value">${azure.filename}</td><td id="allowable-values"></td><td id="description">The filename<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Range Start</td><td>range-start</td><td></td><td id="allowable-values"></td><td id="description">The byte position at which to start reading from the object. An empty value or a value of zero will start reading at the beginning of the object.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Range Length</td><td>range-length</td><td></td><td id="allowable-values"></td><td id="description">The number of bytes to download from the object, starting from the Range Start. An empty value or a value that extends beyond the end of the object will read to the end of the object.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Number of Retries</td><td>number-of-retries</td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">The number of automatic retries to perform if the download fails.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Proxy Configuration Service</td><td>proxy-configuration-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>ProxyConfigurationService<br/><strong>Implementation: </strong><a href="../../../nifi-proxy-configuration-nar/1.19.1/org.apache.nifi.proxy.StandardProxyConfigurationService/index.html">StandardProxyConfigurationService</a></td><td id="description">Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP, SOCKS In case of SOCKS, it is not guaranteed that the selected SOCKS Version will be used by the processor.</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 Azure storage are transferred to this relationship</td></tr><tr><td>failure</td><td>Files that could not be written to Azure storage for some reason are transferred to this relationship</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>azure.datalake.storage.statusCode</td><td>The HTTP error code (if available) from the failed operation</td></tr><tr><td>azure.datalake.storage.errorCode</td><td>The Azure Data Lake Storage moniker of the failed operation</td></tr><tr><td>azure.datalake.storage.errorMessage</td><td>The Azure Data Lake Storage error message from the failed operation</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.azure.storage.PutAzureDataLakeStorage/index.html">PutAzureDataLakeStorage</a>, <a href="../org.apache.nifi.processors.azure.storage.DeleteAzureDataLakeStorage/index.html">DeleteAzureDataLakeStorage</a>, <a href="../org.apache.nifi.processors.azure.storage.ListAzureDataLakeStorage/index.html">ListAzureDataLakeStorage</a></p></body></html> |