AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.azure.storage.datalake.DataLakeComponent>

All Known Implementing Classes:

AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilderImpl

Enclosing interface:

AzureStorageDatalakeComponentBuilderFactory
```
public static interface AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder
extends ComponentBuilder<org.apache.camel.component.azure.storage.datalake.DataLakeComponent>
```
Builder for the Azure storage datalake service component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`accountKey(String accountKey)` account key for authentication.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`autowiredEnabled(boolean autowiredEnabled)` Whether autowiring is enabled.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`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 AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`clientId(String clientId)` client id for azure account.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`clientSecret(String clientSecret)` client secret for azure account.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`clientSecretCredential(com.azure.identity.ClientSecretCredential clientSecretCredential)` client secret credential for authentication.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`close(Boolean close)` Whether or not a file changed event raised indicates completion (true) or modification (false).
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`closeStreamAfterRead(Boolean closeStreamAfterRead)` check for closing stream after read.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`configuration(org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration configuration)` configuration object for datalake.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`dataCount(Long dataCount)` count number of bytes to download.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`directoryName(String directoryName)` directory of the file to be handled in component.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`downloadLinkExpiration(Long downloadLinkExpiration)` download link expiration time.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`expression(String expression)` expression for queryInputStream.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`fileDir(String fileDir)` directory of file to do operations in the local system.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`fileName(String fileName)` name of file to be handled in component.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`fileOffset(Long fileOffset)` offset position in file for different operations.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`maxResults(Integer maxResults)` maximum number of results to show at a time.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`maxRetryRequests(int maxRetryRequests)` no of retries to a given request.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`openOptions(Set<OpenOption> openOptions)` set open options for creating file.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`operation(org.apache.camel.component.azure.storage.datalake.DataLakeOperationsDefinition operation)` operation to be performed.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`path(String path)` path in azure datalake for operations.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`permission(String permission)` permission string for the file.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`position(Long position)` This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`recursive(Boolean recursive)` recursively include all paths.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`regex(String regex)` regular expression for matching file names.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`retainUncommitedData(Boolean retainUncommitedData)` Whether or not uncommitted data is to be retained after the operation.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`serviceClient(com.azure.storage.file.datalake.DataLakeServiceClient serviceClient)` datalake service client for azure storage datalake.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`sharedKeyCredential(com.azure.storage.common.StorageSharedKeyCredential sharedKeyCredential)` shared key credential for azure datalake gen2.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`tenantId(String tenantId)` tenant id for azure account.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`timeout(Duration timeout)` Timeout for operation.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`umask(String umask)` umask permission for file.
`default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder`	`userPrincipalNameReturned(Boolean userPrincipalNameReturned)` whether or not to use upn.

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

- Method Detail
  - accountKey
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder accountKey(String accountKey)
```
    account key for authentication. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    accountKey - the value to set
    
    Returns:
    
    the dsl builder
  - clientId
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder clientId(String clientId)
```
    client id for azure account. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    clientId - the value to set
    
    Returns:
    
    the dsl builder
  - clientSecret
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder clientSecret(String clientSecret)
```
    client secret for azure account. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    clientSecret - the value to set
    
    Returns:
    
    the dsl builder
  - clientSecretCredential
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder clientSecretCredential(com.azure.identity.ClientSecretCredential clientSecretCredential)
```
    client secret credential for authentication. The option is a: <code>com.azure.identity.ClientSecretCredential</code> type. Group: common
    
    Parameters:
    
    clientSecretCredential - the value to set
    
    Returns:
    
    the dsl builder
  - close
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder close(Boolean close)
```
    Whether or not a file changed event raised indicates completion (true) or modification (false). The option is a: <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    close - the value to set
    
    Returns:
    
    the dsl builder
  - closeStreamAfterRead
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder closeStreamAfterRead(Boolean closeStreamAfterRead)
```
    check for closing stream after read. The option is a: <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    closeStreamAfterRead - the value to set
    
    Returns:
    
    the dsl builder
  - configuration
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder configuration(org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration configuration)
```
    configuration object for datalake. The option is a: <code>org.apache.camel.component.azure.storage.datalake.DataLakeConfiguration</code> type. Group: common
    
    Parameters:
    
    configuration - the value to set
    
    Returns:
    
    the dsl builder
  - dataCount
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder dataCount(Long dataCount)
```
    count number of bytes to download. The option is a: <code>java.lang.Long</code> type. Group: common
    
    Parameters:
    
    dataCount - the value to set
    
    Returns:
    
    the dsl builder
  - directoryName
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder directoryName(String directoryName)
```
    directory of the file to be handled in component. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    directoryName - the value to set
    
    Returns:
    
    the dsl builder
  - downloadLinkExpiration
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder downloadLinkExpiration(Long downloadLinkExpiration)
```
    download link expiration time. The option is a: <code>java.lang.Long</code> type. Group: common
    
    Parameters:
    
    downloadLinkExpiration - the value to set
    
    Returns:
    
    the dsl builder
  - expression
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder expression(String expression)
```
    expression for queryInputStream. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    expression - the value to set
    
    Returns:
    
    the dsl builder
  - fileDir
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder fileDir(String fileDir)
```
    directory of file to do operations in the local system. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    fileDir - the value to set
    
    Returns:
    
    the dsl builder
  - fileName
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder fileName(String fileName)
```
    name of file to be handled in component. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    fileName - the value to set
    
    Returns:
    
    the dsl builder
  - fileOffset
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder fileOffset(Long fileOffset)
```
    offset position in file for different operations. The option is a: <code>java.lang.Long</code> type. Group: common
    
    Parameters:
    
    fileOffset - the value to set
    
    Returns:
    
    the dsl builder
  - maxResults
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder maxResults(Integer maxResults)
```
    maximum number of results to show at a time. The option is a: <code>java.lang.Integer</code> type. Group: common
    
    Parameters:
    
    maxResults - the value to set
    
    Returns:
    
    the dsl builder
  - maxRetryRequests
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder maxRetryRequests(int maxRetryRequests)
```
    no of retries to a given request. The option is a: <code>int</code> type. Group: common
    
    Parameters:
    
    maxRetryRequests - the value to set
    
    Returns:
    
    the dsl builder
  - openOptions
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder openOptions(Set<OpenOption> openOptions)
```
    set open options for creating file. The option is a: <code>java.util.Set<java.nio.file.OpenOption></code> type. Group: common
    
    Parameters:
    
    openOptions - the value to set
    
    Returns:
    
    the dsl builder
  - path
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder path(String path)
```
    path in azure datalake for operations. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    path - the value to set
    
    Returns:
    
    the dsl builder
  - permission
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder permission(String permission)
```
    permission string for the file. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    permission - the value to set
    
    Returns:
    
    the dsl builder
  - position
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder position(Long position)
```
    This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. The option is a: <code>java.lang.Long</code> type. Group: common
    
    Parameters:
    
    position - the value to set
    
    Returns:
    
    the dsl builder
  - recursive
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder recursive(Boolean recursive)
```
    recursively include all paths. The option is a: <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    recursive - the value to set
    
    Returns:
    
    the dsl builder
  - regex
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder regex(String regex)
```
    regular expression for matching file names. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    regex - the value to set
    
    Returns:
    
    the dsl builder
  - retainUncommitedData
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder retainUncommitedData(Boolean retainUncommitedData)
```
    Whether or not uncommitted data is to be retained after the operation. The option is a: <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    retainUncommitedData - the value to set
    
    Returns:
    
    the dsl builder
  - serviceClient
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder serviceClient(com.azure.storage.file.datalake.DataLakeServiceClient serviceClient)
```
    datalake service client for azure storage datalake. The option is a: <code>com.azure.storage.file.datalake.DataLakeServiceClient</code> type. Group: common
    
    Parameters:
    
    serviceClient - the value to set
    
    Returns:
    
    the dsl builder
  - sharedKeyCredential
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder sharedKeyCredential(com.azure.storage.common.StorageSharedKeyCredential sharedKeyCredential)
```
    shared key credential for azure datalake gen2. The option is a: <code>com.azure.storage.common.StorageSharedKeyCredential</code> type. Group: common
    
    Parameters:
    
    sharedKeyCredential - the value to set
    
    Returns:
    
    the dsl builder
  - tenantId
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder tenantId(String tenantId)
```
    tenant id for azure account. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    tenantId - the value to set
    
    Returns:
    
    the dsl builder
  - timeout
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder timeout(Duration timeout)
```
    Timeout for operation. The option is a: <code>java.time.Duration</code> type. Group: common
    
    Parameters:
    
    timeout - the value to set
    
    Returns:
    
    the dsl builder
  - umask
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder umask(String umask)
```
    umask permission for file. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    umask - the value to set
    
    Returns:
    
    the dsl builder
  - userPrincipalNameReturned
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder userPrincipalNameReturned(Boolean userPrincipalNameReturned)
```
    whether or not to use upn. The option is a: <code>java.lang.Boolean</code> type. Group: common
    
    Parameters:
    
    userPrincipalNameReturned - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder 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
  - lazyStartProducer
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder 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 AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder operation(org.apache.camel.component.azure.storage.datalake.DataLakeOperationsDefinition operation)
```
    operation to be performed. The option is a: <code>org.apache.camel.component.azure.storage.datalake.DataLakeOperationsDefinition</code> type. Default: listFileSystem Group: producer
    
    Parameters:
    
    operation - the value to set
    
    Returns:
    
    the dsl builder
  - autowiredEnabled
```
default AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder 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

Interface AzureStorageDatalakeComponentBuilderFactory.AzureStorageDatalakeComponentBuilder

Method Summary

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

Method Detail

accountKey

clientId

clientSecret

clientSecretCredential

close

closeStreamAfterRead

configuration

dataCount

directoryName

downloadLinkExpiration

expression

fileDir

fileName

fileOffset

maxResults

maxRetryRequests

openOptions

path

permission

position

recursive

regex

retainUncommitedData

serviceClient

sharedKeyCredential

tenantId

timeout

umask

userPrincipalNameReturned

bridgeErrorHandler

lazyStartProducer

operation

autowiredEnabled