Interface CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    CassandraEndpointBuilderFactory.CassandraEndpointBuilder
    Enclosing interface:
    CassandraEndpointBuilderFactory

    public static interface CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder
    extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the Cassandra CQL component.
    • Method Detail

      • consistencyLevel

        default CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder consistencyLevel​(com.datastax.oss.driver.api.core.DefaultConsistencyLevel consistencyLevel)
        Consistency level to use. The option is a: <code>com.datastax.oss.driver.api.core.DefaultConsistencyLevel</code> type. Group: common
        Parameters:
        consistencyLevel - the value to set
        Returns:
        the dsl builder
      • consistencyLevel

        default CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder consistencyLevel​(String consistencyLevel)
        Consistency level to use. The option will be converted to a <code>com.datastax.oss.driver.api.core.DefaultConsistencyLevel</code> type. Group: common
        Parameters:
        consistencyLevel - the value to set
        Returns:
        the dsl builder
      • loadBalancingPolicyClass

        default CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder loadBalancingPolicyClass​(String loadBalancingPolicyClass)
        To use a specific LoadBalancingPolicyClass. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        loadBalancingPolicyClass - the value to set
        Returns:
        the dsl builder
      • prepareStatements

        default CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder prepareStatements​(boolean prepareStatements)
        Whether to use PreparedStatements or regular Statements. The option is a: <code>boolean</code> type. Default: true Group: common
        Parameters:
        prepareStatements - the value to set
        Returns:
        the dsl builder
      • prepareStatements

        default CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder prepareStatements​(String prepareStatements)
        Whether to use PreparedStatements or regular Statements. The option will be converted to a <code>boolean</code> type. Default: true Group: common
        Parameters:
        prepareStatements - the value to set
        Returns:
        the dsl builder
      • resultSetConversionStrategy

        default CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder resultSetConversionStrategy​(org.apache.camel.component.cassandra.ResultSetConversionStrategy resultSetConversionStrategy)
        To use a custom class that implements logic for converting ResultSet into message body ALL, ONE, LIMIT_10, LIMIT_100... The option is a: <code>org.apache.camel.component.cassandra.ResultSetConversionStrategy</code> type. Group: common
        Parameters:
        resultSetConversionStrategy - the value to set
        Returns:
        the dsl builder
      • resultSetConversionStrategy

        default CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder resultSetConversionStrategy​(String resultSetConversionStrategy)
        To use a custom class that implements logic for converting ResultSet into message body ALL, ONE, LIMIT_10, LIMIT_100... The option will be converted to a <code>org.apache.camel.component.cassandra.ResultSetConversionStrategy</code> type. Group: common
        Parameters:
        resultSetConversionStrategy - the value to set
        Returns:
        the dsl builder
      • session

        default CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder session​(com.datastax.oss.driver.api.core.CqlSession session)
        To use the Session instance (you would normally not use this option). The option is a: <code>com.datastax.oss.driver.api.core.CqlSession</code> type. Group: common
        Parameters:
        session - the value to set
        Returns:
        the dsl builder
      • session

        default CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder session​(String session)
        To use the Session instance (you would normally not use this option). The option will be converted to a <code>com.datastax.oss.driver.api.core.CqlSession</code> type. Group: common
        Parameters:
        session - the value to set
        Returns:
        the dsl builder
      • sendEmptyMessageWhenIdle

        default CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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
      • useFixedDelay

        default CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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 CassandraEndpointBuilderFactory.CassandraEndpointConsumerBuilder 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