FetchAzureDataLakeStorage

Description:

Fetch the provided file from Azure Data Lake Storage

Tags:

azure, microsoft, cloud, storage, adlsgen2, datalake

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, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
ADLS Credentialsadls-credentials-serviceController Service API:
ADLSCredentialsService
Implementation: ADLSCredentialsControllerService
Controller Service used to obtain Azure Credentials.
Filesystem Namefilesystem-nameName of the Azure Storage File System (also called Container). It is assumed to be already existing.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Directory Namedirectory-nameName 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.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
File Namefile-name${azure.filename}The filename
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Range Startrange-startThe 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.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Range Lengthrange-lengthThe 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.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Number of Retriesnumber-of-retries0The number of automatic retries to perform if the download fails.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Proxy Configuration Serviceproxy-configuration-serviceController Service API:
ProxyConfigurationService
Implementation: StandardProxyConfigurationService
Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: SOCKS, HTTP In case of SOCKS, it is not guaranteed that the selected SOCKS Version will be used by the processor.

Relationships:

NameDescription
successFiles that have been successfully written to Azure storage are transferred to this relationship
failureFiles that could not be written to Azure storage for some reason are transferred to this relationship

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
azure.datalake.storage.statusCodeThe HTTP error code (if available) from the failed operation
azure.datalake.storage.errorCodeThe Azure Data Lake Storage moniker of the failed operation
azure.datalake.storage.errorMessageThe Azure Data Lake Storage error message from the failed operation

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.

See Also:

PutAzureDataLakeStorage, DeleteAzureDataLakeStorage, ListAzureDataLakeStorage