AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.azure.blob.BlobServiceComponent>

All Known Implementing Classes:

AzureBlobComponentBuilderFactory.AzureBlobComponentBuilderImpl

Enclosing interface:

AzureBlobComponentBuilderFactory
```
public static interface AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder
extends ComponentBuilder<org.apache.camel.component.azure.blob.BlobServiceComponent>
```
Builder for the Azure Storage Blob Service (Deprecated) component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`autowiredEnabled(boolean autowiredEnabled)` Whether autowiring is enabled.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`azureBlobClient(com.microsoft.azure.storage.blob.CloudBlob azureBlobClient)` The blob service client.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`blobMetadata(Map<String,String> blobMetadata)` Set the blob meta-data.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`blobOffset(Long blobOffset)` Set the blob offset for the upload or download operations, default is 0.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`blobPrefix(String blobPrefix)` Set a prefix which can be used for listing the blobs.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`blobType(org.apache.camel.component.azure.blob.BlobType blobType)` Set a blob type, 'blockblob' is default.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`closeStreamAfterRead(boolean closeStreamAfterRead)` Close the stream after read or keep it open, default is true.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`closeStreamAfterWrite(boolean closeStreamAfterWrite)` Close the stream after write or keep it open, default is true.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`configuration(org.apache.camel.component.azure.blob.BlobServiceConfiguration configuration)` The Blob Service configuration.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`credentials(com.microsoft.azure.storage.StorageCredentials credentials)` Set the storage credentials, required in most cases.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`credentialsAccountKey(String credentialsAccountKey)` Set the storage account key used during authentication phase.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`credentialsAccountName(String credentialsAccountName)` Set the storage account name used during authentication phase.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`dataLength(Long dataLength)` Set the data length for the download or page blob upload operations.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`fileDir(String fileDir)` Set the file directory where the downloaded blobs will be saved to.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`operation(org.apache.camel.component.azure.blob.BlobServiceOperations operation)` Blob service operation hint to the producer.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`publicForRead(boolean publicForRead)` Storage resources can be public for reading their content, if this property is enabled then the credentials do not have to be set.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`streamReadSize(int streamReadSize)` Set the minimum read size in bytes when reading the blob content.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`streamWriteSize(int streamWriteSize)` Set the size of the buffer for writing block and page blocks.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`useFlatListing(boolean useFlatListing)` Specify if the flat or hierarchical blob listing should be used.
`default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder`	`validateClientURI(boolean validateClientURI)` Whether to validate the Azure client URI.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - azureBlobClient
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder azureBlobClient(com.microsoft.azure.storage.blob.CloudBlob azureBlobClient)
```
    The blob service client. The option is a: <code>com.microsoft.azure.storage.blob.CloudBlob</code> type. Group: common
    
    Parameters:
    
    azureBlobClient - the value to set
    
    Returns:
    
    the dsl builder
  - blobOffset
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder blobOffset(Long blobOffset)
```
    Set the blob offset for the upload or download operations, default is 0. The option is a: <code>java.lang.Long</code> type. Default: 0 Group: common
    
    Parameters:
    
    blobOffset - the value to set
    
    Returns:
    
    the dsl builder
  - blobType
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder blobType(org.apache.camel.component.azure.blob.BlobType blobType)
```
    Set a blob type, 'blockblob' is default. The option is a: <code>org.apache.camel.component.azure.blob.BlobType</code> type. Default: blockblob Group: common
    
    Parameters:
    
    blobType - the value to set
    
    Returns:
    
    the dsl builder
  - closeStreamAfterRead
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder closeStreamAfterRead(boolean closeStreamAfterRead)
```
    Close the stream after read or keep it open, default is true. The option is a: <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    closeStreamAfterRead - the value to set
    
    Returns:
    
    the dsl builder
  - credentials
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder credentials(com.microsoft.azure.storage.StorageCredentials credentials)
```
    Set the storage credentials, required in most cases. The option is a: <code>com.microsoft.azure.storage.StorageCredentials</code> type. Group: common
    
    Parameters:
    
    credentials - the value to set
    
    Returns:
    
    the dsl builder
  - dataLength
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder dataLength(Long dataLength)
```
    Set the data length for the download or page blob upload operations. The option is a: <code>java.lang.Long</code> type. Group: common
    
    Parameters:
    
    dataLength - the value to set
    
    Returns:
    
    the dsl builder
  - fileDir
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder fileDir(String fileDir)
```
    Set the file directory where the downloaded blobs will be saved to. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    fileDir - the value to set
    
    Returns:
    
    the dsl builder
  - publicForRead
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder publicForRead(boolean publicForRead)
```
    Storage resources can be public for reading their content, if this property is enabled then the credentials do not have to be set. The option is a: <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    publicForRead - the value to set
    
    Returns:
    
    the dsl builder
  - streamReadSize
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder streamReadSize(int streamReadSize)
```
    Set the minimum read size in bytes when reading the blob content. The option is a: <code>int</code> type. Group: common
    
    Parameters:
    
    streamReadSize - the value to set
    
    Returns:
    
    the dsl builder
  - validateClientURI
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder validateClientURI(boolean validateClientURI)
```
    Whether to validate the Azure client URI. The option is a: <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    validateClientURI - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - blobMetadata
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder blobMetadata(Map<String,String> blobMetadata)
```
    Set the blob meta-data. The option is a: <code>java.util.Map<java.lang.String, java.lang.String></code> type. Group: producer
    
    Parameters:
    
    blobMetadata - the value to set
    
    Returns:
    
    the dsl builder
  - blobPrefix
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder blobPrefix(String blobPrefix)
```
    Set a prefix which can be used for listing the blobs. The option is a: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    blobPrefix - the value to set
    
    Returns:
    
    the dsl builder
  - closeStreamAfterWrite
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder closeStreamAfterWrite(boolean closeStreamAfterWrite)
```
    Close the stream after write or keep it open, default is true. The option is a: <code>boolean</code> type. Default: true Group: producer
    
    Parameters:
    
    closeStreamAfterWrite - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder lazyStartProducer(boolean lazyStartProducer)
```
    Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - operation
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder operation(org.apache.camel.component.azure.blob.BlobServiceOperations operation)
```
    Blob service operation hint to the producer. The option is a: <code>org.apache.camel.component.azure.blob.BlobServiceOperations</code> type. Default: listBlobs Group: producer
    
    Parameters:
    
    operation - the value to set
    
    Returns:
    
    the dsl builder
  - streamWriteSize
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder streamWriteSize(int streamWriteSize)
```
    Set the size of the buffer for writing block and page blocks. The option is a: <code>int</code> type. Group: producer
    
    Parameters:
    
    streamWriteSize - the value to set
    
    Returns:
    
    the dsl builder
  - useFlatListing
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder useFlatListing(boolean useFlatListing)
```
    Specify if the flat or hierarchical blob listing should be used. The option is a: <code>boolean</code> type. Default: true Group: producer
    
    Parameters:
    
    useFlatListing - the value to set
    
    Returns:
    
    the dsl builder
  - autowiredEnabled
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder autowiredEnabled(boolean autowiredEnabled)
```
    Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
    
    Parameters:
    
    autowiredEnabled - the value to set
    
    Returns:
    
    the dsl builder
  - configuration
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder configuration(org.apache.camel.component.azure.blob.BlobServiceConfiguration configuration)
```
    The Blob Service configuration. The option is a: <code>org.apache.camel.component.azure.blob.BlobServiceConfiguration</code> type. Group: advanced
    
    Parameters:
    
    configuration - the value to set
    
    Returns:
    
    the dsl builder
  - credentialsAccountKey
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder credentialsAccountKey(String credentialsAccountKey)
```
    Set the storage account key used during authentication phase. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    credentialsAccountKey - the value to set
    
    Returns:
    
    the dsl builder
  - credentialsAccountName
```
default AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder credentialsAccountName(String credentialsAccountName)
```
    Set the storage account name used during authentication phase. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    credentialsAccountName - the value to set
    
    Returns:
    
    the dsl builder

Interface AzureBlobComponentBuilderFactory.AzureBlobComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

azureBlobClient

blobOffset

blobType

closeStreamAfterRead

credentials

dataLength

fileDir

publicForRead

streamReadSize

validateClientURI

bridgeErrorHandler

blobMetadata

blobPrefix

closeStreamAfterWrite

lazyStartProducer

operation

streamWriteSize

useFlatListing

autowiredEnabled

configuration

credentialsAccountKey

credentialsAccountName