org.apache.camel.builder.endpoint.dsl

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

Modifier and Type	Method and 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(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder	runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls.
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder	scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder	scheduledExecutorService(String 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(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
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	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	startingSha(String startingSha) The starting sha to use for polling commits with the commit consumer.
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.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default GitHubEndpointBuilderFactory.AdvancedGitHubEndpointConsumerBuilder advanced()

repoName

default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder repoName(String repoName)

GitHub repository name. The option is a: <code>java.lang.String</code> type. Required: true Group: common

Parameters:

repoName - the value to set

Returns:

the dsl builder

repoOwner

default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder repoOwner(String repoOwner)

GitHub repository owner (organization). The option is a: <code>java.lang.String</code> type. Required: true Group: common

Parameters:

repoOwner - the value to set

Returns:

the dsl builder

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: <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

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 a <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

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: <code>boolean</code> type. Default: false Group: consumer

Parameters:

sendEmptyMessageWhenIdle - the value to set

Returns:

the dsl builder

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 a <code>boolean</code> type. Default: false Group: consumer

Parameters:

sendEmptyMessageWhenIdle - the value to set

Returns:

the dsl builder

startingSha

default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder startingSha(String startingSha)

The starting sha to use for polling commits with the commit consumer. The value can either be a sha for the sha to start from, or use beginning to start from the beginning, or last to start from the last commit. The option is a: <code>java.lang.String</code> type. Default: last Group: consumer

Parameters:

startingSha - the value to set

Returns:

the dsl builder

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: <code>int</code> type. Group: scheduler

Parameters:

backoffErrorThreshold - the value to set

Returns:

the dsl builder

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 a <code>int</code> type. Group: scheduler

Parameters:

backoffErrorThreshold - the value to set

Returns:

the dsl builder

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: <code>int</code> type. Group: scheduler

Parameters:

backoffIdleThreshold - the value to set

Returns:

the dsl builder

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 a <code>int</code> type. Group: scheduler

Parameters:

backoffIdleThreshold - the value to set

Returns:

the dsl builder

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: <code>int</code> type. Group: scheduler

Parameters:

backoffMultiplier - the value to set

Returns:

the dsl builder

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 a <code>int</code> type. Group: scheduler

Parameters:

backoffMultiplier - the value to set

Returns:

the dsl builder

delay

default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 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: <code>boolean</code> type. Default: false Group: scheduler

Parameters:

greedy - the value to set

Returns:

the dsl builder

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 a <code>boolean</code> type. Default: false Group: scheduler

Parameters:

greedy - the value to set

Returns:

the dsl builder

initialDelay

default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 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: <code>long</code> type. Default: 0 Group: scheduler

Parameters:

repeatCount - the value to set

Returns:

the dsl builder

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 a <code>long</code> type. Default: 0 Group: scheduler

Parameters:

repeatCount - the value to set

Returns:

the dsl builder

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: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler

Parameters:

runLoggingLevel - the value to set

Returns:

the dsl builder

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 a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler

Parameters:

runLoggingLevel - the value to set

Returns:

the dsl builder

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: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler

Parameters:

scheduledExecutorService - the value to set

Returns:

the dsl builder

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 a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler

Parameters:

scheduledExecutorService - the value to set

Returns:

the dsl builder

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: <code>java.lang.Object</code> type. Default: none Group: scheduler

Parameters:

scheduler - the value to set

Returns:

the dsl builder

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 a <code>java.lang.Object</code> type. Default: none Group: scheduler

Parameters:

scheduler - the value to set

Returns:

the dsl builder

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: <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 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: <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 GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder 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 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 a <code>boolean</code> type. Default: true Group: scheduler

Parameters:

useFixedDelay - the value to set

Returns:

the dsl builder

oauthToken

default GitHubEndpointBuilderFactory.GitHubEndpointConsumerBuilder oauthToken(String oauthToken)

GitHub OAuth token. Must be configured on either component or endpoint. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

oauthToken - the value to set

Returns:

the dsl builder