Package org.apache.nifi.processors.azure.storage

Class FetchAzureDataLakeStorage

java.lang.Object
org.apache.nifi.components.AbstractConfigurableComponent
org.apache.nifi.processor.AbstractSessionFactoryProcessor
org.apache.nifi.processor.AbstractProcessor
org.apache.nifi.processors.azure.AbstractAzureDataLakeStorageProcessor
org.apache.nifi.processors.azure.storage.FetchAzureDataLakeStorage
All Implemented Interfaces:
org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.processor.Processor
@Tags({"azure","microsoft","cloud","storage","adlsgen2","datalake"}) @SeeAlso({PutAzureDataLakeStorage.class,DeleteAzureDataLakeStorage.class,ListAzureDataLakeStorage.class}) @CapabilityDescription("Fetch the specified file from Azure Data Lake Storage") @InputRequirement(INPUT_REQUIRED) @WritesAttribute(attribute="azure.datalake.storage.statusCode",description="The HTTP error code (if available) from the failed operation") @WritesAttribute(attribute="azure.datalake.storage.errorCode",description="The Azure Data Lake Storage moniker of the failed operation") @WritesAttribute(attribute="azure.datalake.storage.errorMessage",description="The Azure Data Lake Storage error message from the failed operation") @MultiProcessorUseCase(description="Retrieve all files in an Azure DataLake Storage directory",keywords={"azure","datalake","adls","state","retrieve","fetch","all","stream"},configurations={@ProcessorConfiguration(processorClass=ListAzureDataLakeStorage.class,configuration="The \"Filesystem Name\" property should be set to the name of the Azure Filesystem (also known as a Container) that files reside in. If the flow being built is to be reused elsewhere, it\'s a good idea to parameterize this property by setting it to something like `#{AZURE_FILESYSTEM}`.\nConfigure the \"Directory Name\" property to specify the name of the directory in the file system. If the flow being built is to be reused elsewhere, it\'s a good idea to parameterize this property by setting it to something like `#{AZURE_DIRECTORY}`.\n\nThe \"ADLS Credentials\" property should specify an instance of the ADLSCredentialsService in order to provide credentials for accessing the filesystem.\n\nThe \'success\' Relationship of this Processor is then connected to FetchAzureDataLakeStorage.\n"),@ProcessorConfiguration(processorClass=FetchAzureDataLakeStorage.class,configuration="\"Filesystem Name\" = \"${azure.filesystem}\"\n\"Directory Name\" = \"${azure.directory}\"\n\"File Name\" = \"${azure.filename}\"\n\nThe \"ADLS Credentials\" property should specify an instance of the ADLSCredentialsService in order to provide credentials for accessing the filesystem.\n")}) public class FetchAzureDataLakeStorage extends AbstractAzureDataLakeStorageProcessor

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.apache.nifi.components.PropertyDescriptor
    NUM_RETRIES
     
    private static final List<org.apache.nifi.components.PropertyDescriptor>
    PROPERTIES
     
    static final org.apache.nifi.components.PropertyDescriptor
    RANGE_LENGTH
     
    static final org.apache.nifi.components.PropertyDescriptor
    RANGE_START
     

    Fields inherited from class org.apache.nifi.processors.azure.AbstractAzureDataLakeStorageProcessor

    REL_FAILURE, REL_SUCCESS, TEMP_FILE_DIRECTORY

  • Constructor Summary

    Constructors
    Constructor
    Description
    FetchAzureDataLakeStorage()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.apache.nifi.components.PropertyDescriptor>
    getSupportedPropertyDescriptors()
     
    void
    onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession session)
     

    Methods inherited from class org.apache.nifi.processors.azure.AbstractAzureDataLakeStorageProcessor

    getRelationships, getStorageClient, onScheduled, onStopped

    Methods inherited from class org.apache.nifi.processor.AbstractProcessor

    onTrigger

    Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

    getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

    Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

    customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validate

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

    getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

    Methods inherited from interface org.apache.nifi.processor.Processor

    isStateful, migrateProperties, migrateRelationships

  • Field Details

    • RANGE_START

      public static final org.apache.nifi.components.PropertyDescriptor RANGE_START

    • RANGE_LENGTH

      public static final org.apache.nifi.components.PropertyDescriptor RANGE_LENGTH

    • NUM_RETRIES

      public static final org.apache.nifi.components.PropertyDescriptor NUM_RETRIES

    • PROPERTIES

      private static final List<org.apache.nifi.components.PropertyDescriptor> PROPERTIES

  • Constructor Details

    • FetchAzureDataLakeStorage

      public FetchAzureDataLakeStorage()

  • Method Details

    • getSupportedPropertyDescriptors

      public List<org.apache.nifi.components.PropertyDescriptor> getSupportedPropertyDescriptors()
      Overrides:
      getSupportedPropertyDescriptors in class org.apache.nifi.components.AbstractConfigurableComponent

    • onTrigger

      public void onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession session) throws org.apache.nifi.processor.exception.ProcessException
      Specified by:
      onTrigger in class org.apache.nifi.processor.AbstractProcessor
      Throws:
      org.apache.nifi.processor.exception.ProcessException