Interface GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
GitHubEndpointBuilderFactory.GitHubEndpointBuilder
- Enclosing interface:
- GitHubEndpointBuilderFactory
public static interface GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the GitHub component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default GitHubEndpointBuilderFactory.AdvancedGitHubEndpointConsumerBuilder
advanced()
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
backoffErrorThreshold(int backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
backoffErrorThreshold(String backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
backoffIdleThreshold(int backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
backoffIdleThreshold(String backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
backoffMultiplier(int backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
backoffMultiplier(String backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
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.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
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.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
delay(long delay)
Milliseconds before the next poll.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
delay(String delay)
Milliseconds before the next poll.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
greedy(boolean greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
greedy(String greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
initialDelay(long initialDelay)
Milliseconds before the first poll starts.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
initialDelay(String initialDelay)
Milliseconds before the first poll starts.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
oauthToken(String oauthToken)
GitHub OAuth token.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
repeatCount(long repeatCount)
Specifies a maximum limit of number of fires.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
repeatCount(String repeatCount)
Specifies a maximum limit of number of fires.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
repoName(String repoName)
GitHub repository name.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
repoOwner(String repoOwner)
GitHub repository owner (organization).default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
runLoggingLevel(String runLoggingLevel)
The consumer logs a start/complete log line when it polls.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
The consumer logs a start/complete log line when it polls.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
scheduledExecutorService(String scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
scheduler(Object scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
scheduler(String scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
schedulerProperties(String key, Object value)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
schedulerProperties(Map values)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
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 GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
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 GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
startScheduler(boolean startScheduler)
Whether the scheduler should be auto started.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
startScheduler(String startScheduler)
Whether the scheduler should be auto started.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
timeUnit(String timeUnit)
Time unit for initialDelay and delay options.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
timeUnit(TimeUnit timeUnit)
Time unit for initialDelay and delay options.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
useFixedDelay(boolean useFixedDelay)
Controls if fixed delay or fixed rate is used.default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder
useFixedDelay(String useFixedDelay)
Controls if fixed delay or fixed rate is used.
-
-
-
Method Detail
-
advanced
default GitHubEndpointBuilderFactory.AdvancedGitHubEndpointConsumerBuilder advanced()
-
repoName
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder repoName(String repoName)
GitHub repository name. The option is a:java.lang.String
type. Required: true Group: common
-
repoOwner
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder repoOwner(String repoOwner)
GitHub repository owner (organization). The option is a:java.lang.String
type. Required: true Group: common
-
bridgeErrorHandler
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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:boolean
type. Default: false Group: consumer
-
bridgeErrorHandler
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 aboolean
type. Default: false Group: consumer
-
sendEmptyMessageWhenIdle
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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:boolean
type. Default: false Group: consumer
-
sendEmptyMessageWhenIdle
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 aboolean
type. Default: false Group: consumer
-
backoffErrorThreshold
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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:int
type. Group: scheduler
-
backoffErrorThreshold
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 aint
type. Group: scheduler
-
backoffIdleThreshold
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a:int
type. Group: scheduler
-
backoffIdleThreshold
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to aint
type. Group: scheduler
-
backoffMultiplier
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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:int
type. Group: scheduler
-
backoffMultiplier
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 aint
type. Group: scheduler
-
delay
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder delay(long delay)
Milliseconds before the next poll. The option is a:long
type. Default: 500 Group: scheduler
-
delay
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder delay(String delay)
Milliseconds before the next poll. The option will be converted to along
type. Default: 500 Group: scheduler
-
greedy
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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:boolean
type. Default: false Group: scheduler
-
greedy
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 aboolean
type. Default: false Group: scheduler
-
initialDelay
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder initialDelay(long initialDelay)
Milliseconds before the first poll starts. The option is a:long
type. Default: 1000 Group: scheduler
-
initialDelay
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder initialDelay(String initialDelay)
Milliseconds before the first poll starts. The option will be converted to along
type. Default: 1000 Group: scheduler
-
repeatCount
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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:long
type. Default: 0 Group: scheduler
-
repeatCount
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 along
type. Default: 0 Group: scheduler
-
runLoggingLevel
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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:org.apache.camel.LoggingLevel
type. Default: TRACE Group: scheduler
-
runLoggingLevel
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 aorg.apache.camel.LoggingLevel
type. Default: TRACE Group: scheduler
-
scheduledExecutorService
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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:java.util.concurrent.ScheduledExecutorService
type. Group: scheduler
-
scheduledExecutorService
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 ajava.util.concurrent.ScheduledExecutorService
type. Group: scheduler
-
scheduler
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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:java.lang.Object
type. Default: none Group: scheduler
-
scheduler
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 ajava.lang.Object
type. Default: none Group: scheduler
-
schedulerProperties
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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:java.util.Map<java.lang.String, java.lang.Object>
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
-
schedulerProperties
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder schedulerProperties(Map values)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a:java.util.Map<java.lang.String, java.lang.Object>
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
-
startScheduler
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder startScheduler(boolean startScheduler)
Whether the scheduler should be auto started. The option is a:boolean
type. Default: true Group: scheduler
-
startScheduler
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder startScheduler(String startScheduler)
Whether the scheduler should be auto started. The option will be converted to aboolean
type. Default: true Group: scheduler
-
timeUnit
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)
Time unit for initialDelay and delay options. The option is a:java.util.concurrent.TimeUnit
type. Default: MILLISECONDS Group: scheduler
-
timeUnit
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder timeUnit(String timeUnit)
Time unit for initialDelay and delay options. The option will be converted to ajava.util.concurrent.TimeUnit
type. Default: MILLISECONDS Group: scheduler
-
useFixedDelay
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a:boolean
type. Default: true Group: scheduler
-
useFixedDelay
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder useFixedDelay(String useFixedDelay)
Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to aboolean
type. Default: true Group: scheduler
-
oauthToken
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder oauthToken(String oauthToken)
GitHub OAuth token. Must be configured on either component or endpoint. The option is a:java.lang.String
type. Group: security
-
-