Interface SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
SlackEndpointBuilderFactory.SlackEndpointBuilder
- Enclosing interface:
- SlackEndpointBuilderFactory
public static interface SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Slack component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default SlackEndpointBuilderFactory.AdvancedSlackEndpointConsumerBuilder
advanced()
default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
backoffErrorThreshold(int backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
backoffErrorThreshold(String backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
backoffIdleThreshold(int backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
backoffIdleThreshold(String backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
backoffMultiplier(int backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
backoffMultiplier(String backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
conversationType(com.slack.api.model.ConversationType conversationType)
Type of conversation.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
conversationType(String conversationType)
Type of conversation.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
delay(long delay)
Milliseconds before the next poll.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
delay(String delay)
Milliseconds before the next poll.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
greedy(boolean greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
greedy(String greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
initialDelay(long initialDelay)
Milliseconds before the first poll starts.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
initialDelay(String initialDelay)
Milliseconds before the first poll starts.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
maxResults(String maxResults)
The Max Result for the poll.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
naturalOrder(boolean naturalOrder)
Create exchanges in natural order (oldest to newest) or not.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
naturalOrder(String naturalOrder)
Create exchanges in natural order (oldest to newest) or not.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
repeatCount(long repeatCount)
Specifies a maximum limit of number of fires.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
repeatCount(String repeatCount)
Specifies a maximum limit of number of fires.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
runLoggingLevel(String runLoggingLevel)
The consumer logs a start/complete log line when it polls.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
The consumer logs a start/complete log line when it polls.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
scheduledExecutorService(String scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
scheduler(Object scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
scheduler(String scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
schedulerProperties(String key, Object value)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
schedulerProperties(Map values)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
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.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
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.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
serverUrl(String serverUrl)
The Server URL of the Slack instance.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
startScheduler(boolean startScheduler)
Whether the scheduler should be auto started.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
startScheduler(String startScheduler)
Whether the scheduler should be auto started.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
timeUnit(String timeUnit)
Time unit for initialDelay and delay options.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
timeUnit(TimeUnit timeUnit)
Time unit for initialDelay and delay options.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
token(String token)
The token to access Slack.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
useFixedDelay(boolean useFixedDelay)
Controls if fixed delay or fixed rate is used.default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder
useFixedDelay(String useFixedDelay)
Controls if fixed delay or fixed rate is used.
-
-
-
Method Detail
-
advanced
default SlackEndpointBuilderFactory.AdvancedSlackEndpointConsumerBuilder advanced()
-
token
default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder token(String token)
The token to access Slack. This app needs to have channels:history, groups:history, im:history, mpim:history, channels:read, groups:read, im:read and mpim:read permissions. The User OAuth Token is the kind of token needed. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
token
- the value to set- Returns:
- the dsl builder
-
conversationType
default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder conversationType(com.slack.api.model.ConversationType conversationType)
Type of conversation. The option is a: <code>com.slack.api.model.ConversationType</code> type. Default: PUBLIC_CHANNEL Group: consumer- Parameters:
conversationType
- the value to set- Returns:
- the dsl builder
-
conversationType
default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder conversationType(String conversationType)
Type of conversation. The option will be converted to a <code>com.slack.api.model.ConversationType</code> type. Default: PUBLIC_CHANNEL Group: consumer- Parameters:
conversationType
- the value to set- Returns:
- the dsl builder
-
maxResults
default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder maxResults(String maxResults)
The Max Result for the poll. The option is a: <code>java.lang.String</code> type. Default: 10 Group: consumer- Parameters:
maxResults
- the value to set- Returns:
- the dsl builder
-
naturalOrder
default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder naturalOrder(boolean naturalOrder)
Create exchanges in natural order (oldest to newest) or not. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
naturalOrder
- the value to set- Returns:
- the dsl builder
-
naturalOrder
default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder naturalOrder(String naturalOrder)
Create exchanges in natural order (oldest to newest) or not. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
naturalOrder
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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
-
serverUrl
default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder serverUrl(String serverUrl)
The Server URL of the Slack instance. The option is a: <code>java.lang.String</code> type. Default: https://slack.com Group: consumer- Parameters:
serverUrl
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder delay(long 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
default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder delay(String 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
default SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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 SlackEndpointBuilderFactory.SlackEndpointConsumerBuilder 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
-
-