Class FetchAzureBlobStorage_v12
java.lang.Object
org.apache.nifi.components.AbstractConfigurableComponent
org.apache.nifi.processor.AbstractSessionFactoryProcessor
org.apache.nifi.processor.AbstractProcessor
org.apache.nifi.processors.azure.AbstractAzureBlobProcessor_v12
org.apache.nifi.processors.azure.storage.FetchAzureBlobStorage_v12
- All Implemented Interfaces:
org.apache.nifi.components.ConfigurableComponent,org.apache.nifi.processor.Processor,ClientSideEncryptionSupport
@Tags({"azure","microsoft","cloud","storage","blob"})
@CapabilityDescription("Retrieves the specified blob from Azure Blob Storage and writes its content to the content of the FlowFile. The processor uses Azure Blob Storage client library v12.")
@SeeAlso({ListAzureBlobStorage_v12.class,PutAzureBlobStorage_v12.class,DeleteAzureBlobStorage_v12.class})
@InputRequirement(INPUT_REQUIRED)
@WritesAttribute(attribute="azure.container",description="The name of the Azure Blob Storage container") @WritesAttribute(attribute="azure.blobname",description="The name of the blob on Azure Blob Storage") @WritesAttribute(attribute="azure.primaryUri",description="Primary location of the blob") @WritesAttribute(attribute="azure.etag",description="ETag of the blob") @WritesAttribute(attribute="azure.blobtype",description="Type of the blob (either BlockBlob, PageBlob or AppendBlob)") @WritesAttribute(attribute="mime.type",description="MIME Type of the content") @WritesAttribute(attribute="lang",description="Language code for the content") @WritesAttribute(attribute="azure.timestamp",description="Timestamp of the blob") @WritesAttribute(attribute="azure.length",description="Length of the blob")
@MultiProcessorUseCase(description="Retrieve all files in an Azure Blob Storage container",keywords={"azure","blob","storage","state","retrieve","fetch","all","stream"},configurations={@ProcessorConfiguration(processorClass=ListAzureBlobStorage_v12.class,configuration="The \"Container Name\" property should be set to the name of the Blob Storage 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_CONTAINER}`.\n\nThe \"Storage Credentials\" property should specify an instance of the AzureStorageCredentialsService_v12 in order to provide credentials for accessing the storage container.\n\nThe \'success\' Relationship of this Processor is then connected to FetchAzureBlobStorage_v12.\n"),@ProcessorConfiguration(processorClass=FetchAzureBlobStorage_v12.class,configuration="\"Container Name\" = \"${azure.container}\"\n\"Blob Name\" = \"${azure.blobname}\"\n\nThe \"Storage Credentials\" property should specify an instance of the AzureStorageCredentialsService_v12 in order to provide credentials for accessing the storage container.\n")})
public class FetchAzureBlobStorage_v12
extends AbstractAzureBlobProcessor_v12
implements ClientSideEncryptionSupport
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final org.apache.nifi.components.PropertyDescriptorstatic final org.apache.nifi.components.PropertyDescriptorprivate static final List<org.apache.nifi.components.PropertyDescriptor> static final org.apache.nifi.components.PropertyDescriptorstatic final org.apache.nifi.components.PropertyDescriptorFields inherited from class org.apache.nifi.processors.azure.AbstractAzureBlobProcessor_v12
REL_FAILURE, REL_SUCCESSFields inherited from interface org.apache.nifi.processors.azure.ClientSideEncryptionSupport
CSE_KEY_ID, CSE_KEY_TYPE, CSE_LOCAL_KEY, KEY_OPERATIONS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected Collection<org.apache.nifi.components.ValidationResult> customValidate(org.apache.nifi.components.ValidationContext validationContext) protected List<org.apache.nifi.components.PropertyDescriptor> voidonTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.ProcessSession session) Methods inherited from class org.apache.nifi.processors.azure.AbstractAzureBlobProcessor_v12
applyBlobMetadata, applyStandardBlobAttributes, createBlobAttributesMap, getRelationships, getStorageClient, getStorageClient, onScheduled, onStoppedMethods inherited from class org.apache.nifi.processor.AbstractProcessor
onTriggerMethods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor
getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrueMethods inherited from class org.apache.nifi.components.AbstractConfigurableComponent
equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validateMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.nifi.processors.azure.ClientSideEncryptionSupport
getEncryptedBlobClient, getKeyWrapAlgorithm, isClientSideEncryptionEnabled, validateClientSideEncryptionProperties, validateLocalKeyMethods inherited from interface org.apache.nifi.components.ConfigurableComponent
getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validateMethods inherited from interface org.apache.nifi.processor.Processor
isStateful, migrateProperties, migrateRelationships
-
Field Details
-
CONTAINER
public static final org.apache.nifi.components.PropertyDescriptor CONTAINER -
BLOB_NAME
public static final org.apache.nifi.components.PropertyDescriptor BLOB_NAME -
RANGE_START
public static final org.apache.nifi.components.PropertyDescriptor RANGE_START -
RANGE_LENGTH
public static final org.apache.nifi.components.PropertyDescriptor RANGE_LENGTH -
PROPERTIES
-
-
Constructor Details
-
FetchAzureBlobStorage_v12
public FetchAzureBlobStorage_v12()
-
-
Method Details
-
customValidate
protected Collection<org.apache.nifi.components.ValidationResult> customValidate(org.apache.nifi.components.ValidationContext validationContext) - Overrides:
customValidatein classorg.apache.nifi.components.AbstractConfigurableComponent
-
getSupportedPropertyDescriptors
- Overrides:
getSupportedPropertyDescriptorsin classorg.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:
onTriggerin classorg.apache.nifi.processor.AbstractProcessor- Throws:
org.apache.nifi.processor.exception.ProcessException
-