Interface TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointBuilder
- Enclosing interface:
- TwitterDirectMessageEndpointBuilderFactory
public static interface TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilderBuilder for endpoint consumers for the Twitter Direct Message component.
-
-
Method Summary
-
-
-
Method Detail
-
advanced
default TwitterDirectMessageEndpointBuilderFactory.AdvancedTwitterDirectMessageEndpointConsumerBuilder advanced()
-
sendEmptyMessageWhenIdle
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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
-
type
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder type(String type)
Endpoint type to use. The option will be converted to 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
-
count
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder count(Integer count)
Limiting number of results per page. The option is a: <code>java.lang.Integer</code> type. Default: 5 Group: filter- Parameters:
count- the value to set- Returns:
- the dsl builder
-
count
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder count(String count)
Limiting number of results per page. The option will be converted to a <code>java.lang.Integer</code> type. Default: 5 Group: filter- Parameters:
count- the value to set- Returns:
- the dsl builder
-
filterOld
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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
-
lang
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder lang(String lang)
The lang string ISO_639-1 which will be used for searching. The option is a: <code>java.lang.String</code> type. Group: filter- Parameters:
lang- the value to set- Returns:
- the dsl builder
-
numberOfPages
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder numberOfPages(Integer numberOfPages)
The number of pages result which you want camel-twitter to consume. The option is a: <code>java.lang.Integer</code> type. Default: 1 Group: filter- Parameters:
numberOfPages- the value to set- Returns:
- the dsl builder
-
numberOfPages
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder numberOfPages(String numberOfPages)
The number of pages result which you want camel-twitter to consume. The option will be converted to a <code>java.lang.Integer</code> type. Default: 1 Group: filter- Parameters:
numberOfPages- the value to set- Returns:
- the dsl builder
-
sinceId
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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
-
userIds
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder userIds(String userIds)
To filter by user ids for filter. Multiple values can be separated by comma. The option is a: <code>java.lang.String</code> type. Group: filter- Parameters:
userIds- the value to set- Returns:
- the dsl builder
-
httpProxyHost
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder delay(long delay)
Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 30000 Group: scheduler- Parameters:
delay- the value to set- Returns:
- the dsl builder
-
delay
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder delay(String delay)
Milliseconds before the next poll. The option will be converted to a <code>long</code> type. Default: 30000 Group: scheduler- Parameters:
delay- the value to set- Returns:
- the dsl builder
-
greedy
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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
-
initialDelay
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder initialDelay(String 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
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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<java.lang.String, java.lang.Object></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 keyvalue- the option value- Returns:
- the dsl builder
-
schedulerProperties
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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<java.lang.String, java.lang.Object></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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder timeUnit(TimeUnit 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
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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 TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder 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
-
accessToken
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder accessToken(String accessToken)
The access token. Can also be configured on the TwitterComponent level instead. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
accessToken- the value to set- Returns:
- the dsl builder
-
accessTokenSecret
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder accessTokenSecret(String accessTokenSecret)
The access secret. Can also be configured on the TwitterComponent level instead. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
accessTokenSecret- the value to set- Returns:
- the dsl builder
-
consumerKey
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder consumerKey(String consumerKey)
The consumer key. Can also be configured on the TwitterComponent level instead. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
consumerKey- the value to set- Returns:
- the dsl builder
-
consumerSecret
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder consumerSecret(String consumerSecret)
The consumer secret. Can also be configured on the TwitterComponent level instead. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
consumerSecret- the value to set- Returns:
- the dsl builder
-
sortById
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder sortById(boolean sortById)
Sorts by id, so the oldest are first, and newest last. The option is a: <code>boolean</code> type. Default: true Group: sort- Parameters:
sortById- the value to set- Returns:
- the dsl builder
-
sortById
default TwitterDirectMessageEndpointBuilderFactory.TwitterDirectMessageEndpointConsumerBuilder sortById(String sortById)
Sorts by id, so the oldest are first, and newest last. The option will be converted to a <code>boolean</code> type. Default: true Group: sort- Parameters:
sortById- the value to set- Returns:
- the dsl builder
-
-