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

Interface TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder

    • Method Detail

      • bridgeErrorHandler

        default TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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

      • type

        default TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder type​(org.apache.camel.component.twitter.data.EndpointType type)
        Endpoint type to use. The option is a: <code>org.apache.camel.component.twitter.data.EndpointType</code> type. Default: polling Group: consumer
        Parameters:
        type - the value to set
        Returns:
        the dsl builder

      • filterOld

        default TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder filterOld​(boolean filterOld)
        Filter out old tweets, that has previously been polled. This state is stored in memory only, and based on last tweet id. The option is a: <code>boolean</code> type. Default: true Group: filter
        Parameters:
        filterOld - the value to set
        Returns:
        the dsl builder

      • filterOld

        default TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder filterOld​(String filterOld)
        Filter out old tweets, that has previously been polled. This state is stored in memory only, and based on last tweet id. The option will be converted to a <code>boolean</code> type. Default: true Group: filter
        Parameters:
        filterOld - the value to set
        Returns:
        the dsl builder

      • sinceId

        default TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder sinceId​(long sinceId)
        The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running. The option is a: <code>long</code> type. Default: 1 Group: filter
        Parameters:
        sinceId - the value to set
        Returns:
        the dsl builder

      • sinceId

        default TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder sinceId​(String sinceId)
        The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running. The option will be converted to a <code>long</code> type. Default: 1 Group: filter
        Parameters:
        sinceId - the value to set
        Returns:
        the dsl builder

      • httpProxyHost

        default TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder httpProxyHost​(String httpProxyHost)
        The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        httpProxyHost - the value to set
        Returns:
        the dsl builder

      • httpProxyPassword

        default TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder httpProxyPassword​(String httpProxyPassword)
        The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        httpProxyPassword - the value to set
        Returns:
        the dsl builder

      • httpProxyPort

        default TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder httpProxyPort​(Integer httpProxyPort)
        The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. The option is a: <code>java.lang.Integer</code> type. Group: proxy
        Parameters:
        httpProxyPort - the value to set
        Returns:
        the dsl builder

      • httpProxyPort

        default TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder httpProxyPort​(String httpProxyPort)
        The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. The option will be converted to a <code>java.lang.Integer</code> type. Group: proxy
        Parameters:
        httpProxyPort - the value to set
        Returns:
        the dsl builder

      • httpProxyUser

        default TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder httpProxyUser​(String httpProxyUser)
        The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. The option is a: <code>java.lang.String</code> type. Group: proxy
        Parameters:
        httpProxyUser - the value to set
        Returns:
        the dsl builder

      • backoffErrorThreshold

        default TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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

      • useFixedDelay

        default TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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 TwitterSearchEndpointBuilderFactory.TwitterSearchEndpointConsumerBuilder 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