Package org.apache.camel.builder.endpoint.dsl

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 Detail

      • clientSecretCredential

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder clientSecretCredential​(Object 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

      • 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: common
        Parameters:
        clientSecretCredential - the value to set
        Returns:
        the dsl builder

      • close

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder close​(String 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​(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

      • dataLakeServiceClient

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder dataLakeServiceClient​(Object 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

      • 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

      • position

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

      • position

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder position​(String 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

      • 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​(Object 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

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder serviceClient​(String 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​(Object 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

      • 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

      • bridgeErrorHandler

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

      • bridgeErrorHandler

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder bridgeErrorHandler​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        bridgeErrorHandler - 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

      • greedy

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder greedy​(boolean 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

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder greedy​(String 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

      • repeatCount

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder repeatCount​(long 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

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder repeatCount​(String 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

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder runLoggingLevel​(String 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

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder scheduler​(Object 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

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder scheduler​(String 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

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder schedulerProperties​(String key,
                                                                                           Object value)
        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

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder schedulerProperties​(Map values)
        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

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder startScheduler​(String 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

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder timeUnit​(String 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

        default DataLakeEndpointBuilderFactory.DataLakeEndpointConsumerBuilder useFixedDelay​(String 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