Interface DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
DataLakeEndpointBuilderFactory.DataLakeEndpointBuilder
Enclosing interface:
DataLakeEndpointBuilderFactory

public static interface DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Azure Storage Datalake Service component.
  • Method Details

    • advanced

    • 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
    • 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
    • close

      Whether or not a file changed event raised indicates completion (true) or modification (false). The option will be converted to a <code>java.lang.Boolean</code> type. Group: common
      Parameters:
      close - the value to set
      Returns:
      the dsl builder
    • closeStreamAfterRead

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder 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
    • closeStreamAfterRead

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder closeStreamAfterRead(String closeStreamAfterRead)
      check for closing stream after read. The option will be converted to a <code>java.lang.Boolean</code> type. Group: common
      Parameters:
      closeStreamAfterRead - the value to set
      Returns:
      the dsl builder
    • 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
    • dataCount

      count number of bytes to download. The option will be converted to a <code>java.lang.Long</code> type. Group: common
      Parameters:
      dataCount - the value to set
      Returns:
      the dsl builder
    • dataLakeServiceClient

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder dataLakeServiceClient(com.azure.storage.file.datalake.DataLakeServiceClient dataLakeServiceClient)
      service client of datalake. The option is a: <code>com.azure.storage.file.datalake.DataLakeServiceClient</code> type. Group: common
      Parameters:
      dataLakeServiceClient - the value to set
      Returns:
      the dsl builder
    • dataLakeServiceClient

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder dataLakeServiceClient(String dataLakeServiceClient)
      service client of datalake. The option will be converted to a <code>com.azure.storage.file.datalake.DataLakeServiceClient</code> type. Group: common
      Parameters:
      dataLakeServiceClient - the value to set
      Returns:
      the dsl builder
    • 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 DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder 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
    • downloadLinkExpiration

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder downloadLinkExpiration(String downloadLinkExpiration)
      download link expiration time. The option will be converted to a <code>java.lang.Long</code> type. Group: common
      Parameters:
      downloadLinkExpiration - the value to set
      Returns:
      the dsl builder
    • 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

      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

      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

      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
    • fileOffset

      offset position in file for different operations. The option will be converted to a <code>java.lang.Long</code> type. Group: common
      Parameters:
      fileOffset - the value to set
      Returns:
      the dsl builder
    • 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
    • maxResults

      maximum number of results to show at a time. The option will be converted to a <code>java.lang.Integer</code> type. Group: common
      Parameters:
      maxResults - the value to set
      Returns:
      the dsl builder
    • maxRetryRequests

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder 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
    • maxRetryRequests

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder maxRetryRequests(String maxRetryRequests)
      no of retries to a given request. The option will be converted to a <code>int</code> type. Group: common
      Parameters:
      maxRetryRequests - the value to set
      Returns:
      the dsl builder
    • openOptions

      set open options for creating file. The option is a: <code>java.util.Set&lt;java.nio.file.OpenOption&gt;</code> type. Group: common
      Parameters:
      openOptions - the value to set
      Returns:
      the dsl builder
    • openOptions

      set open options for creating file. The option will be converted to a <code>java.util.Set&lt;java.nio.file.OpenOption&gt;</code> type. Group: common
      Parameters:
      openOptions - the value to set
      Returns:
      the dsl builder
    • 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

      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

      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
    • 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 will be converted to a <code>java.lang.Long</code> type. Group: common
      Parameters:
      position - the value to set
      Returns:
      the dsl builder
    • 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
    • recursive

      recursively include all paths. The option will be converted to a <code>java.lang.Boolean</code> type. Group: common
      Parameters:
      recursive - the value to set
      Returns:
      the dsl builder
    • 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 DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder 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
    • retainUncommitedData

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder retainUncommitedData(String retainUncommitedData)
      Whether or not uncommitted data is to be retained after the operation. The option will be converted to a <code>java.lang.Boolean</code> type. Group: common
      Parameters:
      retainUncommitedData - the value to set
      Returns:
      the dsl builder
    • serviceClient

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder 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
    • serviceClient

      datalake service client for azure storage datalake. The option will be converted to a <code>com.azure.storage.file.datalake.DataLakeServiceClient</code> type. Group: common
      Parameters:
      serviceClient - the value to set
      Returns:
      the dsl builder
    • sharedKeyCredential

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder 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
    • sharedKeyCredential

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder sharedKeyCredential(String sharedKeyCredential)
      shared key credential for azure datalake gen2. The option will be converted to a <code>com.azure.storage.common.StorageSharedKeyCredential</code> type. Group: common
      Parameters:
      sharedKeyCredential - the value to set
      Returns:
      the dsl builder
    • 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

      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
    • timeout

      Timeout for operation. The option will be converted to a <code>java.time.Duration</code> type. Group: common
      Parameters:
      timeout - the value to set
      Returns:
      the dsl builder
    • 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 DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder 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
    • userPrincipalNameReturned

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder userPrincipalNameReturned(String userPrincipalNameReturned)
      whether or not to use upn. The option will be converted to a <code>java.lang.Boolean</code> type. Group: common
      Parameters:
      userPrincipalNameReturned - the value to set
      Returns:
      the dsl builder
    • sendEmptyMessageWhenIdle

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)
      If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder
    • sendEmptyMessageWhenIdle

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)
      If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder
    • backoffErrorThreshold

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold)
      The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder
    • backoffErrorThreshold

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold)
      The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder
    • backoffIdleThreshold

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder
    • backoffIdleThreshold

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder
    • backoffMultiplier

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder backoffMultiplier(int backoffMultiplier)
      To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: <code>int</code> type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder
    • backoffMultiplier

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder backoffMultiplier(String backoffMultiplier)
      To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a <code>int</code> type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder
    • delay

      Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder
    • delay

      Milliseconds before the next poll. The option will be converted to a <code>long</code> type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder
    • greedy

      If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder
    • greedy

      If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder
    • initialDelay

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder initialDelay(long initialDelay)
      Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder
    • initialDelay

      Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder
    • repeatCount

      Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: <code>long</code> type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder
    • repeatCount

      Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder
    • runLoggingLevel

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
      The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder
    • runLoggingLevel

      The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder
    • scheduledExecutorService

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
      Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder
    • scheduledExecutorService

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService)
      Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder
    • scheduler

      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder
    • scheduler

      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder
    • schedulerProperties

      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder
    • schedulerProperties

      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
      Parameters:
      values - the values
      Returns:
      the dsl builder
    • startScheduler

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder startScheduler(boolean startScheduler)
      Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder
    • startScheduler

      Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder
    • timeUnit

      Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder
    • timeUnit

      Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder
    • useFixedDelay

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder
    • useFixedDelay

      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder
    • accountKey

      account key for authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      accountKey - the value to set
      Returns:
      the dsl builder
    • clientSecret

      client secret for azure account. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      clientSecret - the value to set
      Returns:
      the dsl builder
    • clientSecretCredential

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder clientSecretCredential(com.azure.identity.ClientSecretCredential clientSecretCredential)
      client secret credential for authentication. The option is a: <code>com.azure.identity.ClientSecretCredential</code> type. Group: security
      Parameters:
      clientSecretCredential - the value to set
      Returns:
      the dsl builder
    • clientSecretCredential

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder clientSecretCredential(String clientSecretCredential)
      client secret credential for authentication. The option will be converted to a <code>com.azure.identity.ClientSecretCredential</code> type. Group: security
      Parameters:
      clientSecretCredential - the value to set
      Returns:
      the dsl builder
    • sasCredential

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder sasCredential(com.azure.core.credential.AzureSasCredential sasCredential)
      SAS token credential. The option is a: <code>com.azure.core.credential.AzureSasCredential</code> type. Group: security
      Parameters:
      sasCredential - the value to set
      Returns:
      the dsl builder
    • sasCredential

      SAS token credential. The option will be converted to a <code>com.azure.core.credential.AzureSasCredential</code> type. Group: security
      Parameters:
      sasCredential - the value to set
      Returns:
      the dsl builder
    • sasSignature

      SAS token signature. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sasSignature - the value to set
      Returns:
      the dsl builder
    • useDefaultIdentity

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder useDefaultIdentity(Boolean useDefaultIdentity)
      Use default identity. The option is a: <code>java.lang.Boolean</code> type. Group: security
      Parameters:
      useDefaultIdentity - the value to set
      Returns:
      the dsl builder
    • useDefaultIdentity

      default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder useDefaultIdentity(String useDefaultIdentity)
      Use default identity. The option will be converted to a <code>java.lang.Boolean</code> type. Group: security
      Parameters:
      useDefaultIdentity - the value to set
      Returns:
      the dsl builder