Interface GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- Enclosing interface:
- GoogleMailStreamEndpointBuilderFactory
public static interface GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint for the Google Mail Stream component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
accessToken(String accessToken)
OAuth 2 access token.default GoogleMailStreamEndpointBuilderFactory.AdvancedGoogleMailStreamEndpointBuilder
advanced()
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
applicationName(String applicationName)
Google mail application name.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
backoffErrorThreshold(int backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
backoffErrorThreshold(String backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
backoffIdleThreshold(int backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
backoffIdleThreshold(String backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
backoffMultiplier(int backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
backoffMultiplier(String backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
clientId(String clientId)
Client ID of the mail application.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
clientSecret(String clientSecret)
Client secret of the mail application.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
delay(long delay)
Milliseconds before the next poll.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
delay(String delay)
Milliseconds before the next poll.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
greedy(boolean greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
greedy(String greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
initialDelay(long initialDelay)
Milliseconds before the first poll starts.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
initialDelay(String initialDelay)
Milliseconds before the first poll starts.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
labels(String labels)
Comma separated list of labels to take into account.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
markAsRead(boolean markAsRead)
Mark the message as read once it has been consumed.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
markAsRead(String markAsRead)
Mark the message as read once it has been consumed.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
maxResults(long maxResults)
Max results to be returned.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
maxResults(String maxResults)
Max results to be returned.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
query(String query)
The query to execute on gmail box.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
refreshToken(String refreshToken)
OAuth 2 refresh token.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
repeatCount(long repeatCount)
Specifies a maximum limit of number of fires.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
repeatCount(String repeatCount)
Specifies a maximum limit of number of fires.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
runLoggingLevel(String runLoggingLevel)
The consumer logs a start/complete log line when it polls.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
The consumer logs a start/complete log line when it polls.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
scheduledExecutorService(String scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
scheduler(Object scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
scheduler(String scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
schedulerProperties(String key, Object value)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
schedulerProperties(Map values)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
startScheduler(boolean startScheduler)
Whether the scheduler should be auto started.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
startScheduler(String startScheduler)
Whether the scheduler should be auto started.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
timeUnit(String timeUnit)
Time unit for initialDelay and delay options.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
timeUnit(TimeUnit timeUnit)
Time unit for initialDelay and delay options.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
useFixedDelay(boolean useFixedDelay)
Controls if fixed delay or fixed rate is used.default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder
useFixedDelay(String useFixedDelay)
Controls if fixed delay or fixed rate is used.
-
-
-
Method Detail
-
advanced
default GoogleMailStreamEndpointBuilderFactory.AdvancedGoogleMailStreamEndpointBuilder advanced()
-
applicationName
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder applicationName(String applicationName)
Google mail application name. Example would be camel-google-mail/1.0. The option is a:java.lang.String
type. Group: consumer
-
bridgeErrorHandler
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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
-
clientId
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder clientId(String clientId)
Client ID of the mail application. The option is a:java.lang.String
type. Group: consumer
-
labels
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder labels(String labels)
Comma separated list of labels to take into account. The option is a:java.lang.String
type. Group: consumer
-
markAsRead
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder markAsRead(boolean markAsRead)
Mark the message as read once it has been consumed. The option is a:boolean
type. Default: false Group: consumer
-
markAsRead
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder markAsRead(String markAsRead)
Mark the message as read once it has been consumed. The option will be converted to aboolean
type. Default: false Group: consumer
-
maxResults
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder maxResults(long maxResults)
Max results to be returned. The option is a:long
type. Default: 10 Group: consumer
-
maxResults
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder maxResults(String maxResults)
Max results to be returned. The option will be converted to along
type. Default: 10 Group: consumer
-
query
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder query(String query)
The query to execute on gmail box. The option is a:java.lang.String
type. Default: is:unread Group: consumer
-
sendEmptyMessageWhenIdle
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder delay(long delay)
Milliseconds before the next poll. The option is a:long
type. Default: 500 Group: scheduler
-
delay
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder delay(String delay)
Milliseconds before the next poll. The option will be converted to along
type. Default: 500 Group: scheduler
-
greedy
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder initialDelay(long initialDelay)
Milliseconds before the first poll starts. The option is a:long
type. Default: 1000 Group: scheduler
-
initialDelay
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder initialDelay(String initialDelay)
Milliseconds before the first poll starts. The option will be converted to along
type. Default: 1000 Group: scheduler
-
repeatCount
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder startScheduler(boolean startScheduler)
Whether the scheduler should be auto started. The option is a:boolean
type. Default: true Group: scheduler
-
startScheduler
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder startScheduler(String startScheduler)
Whether the scheduler should be auto started. The option will be converted to aboolean
type. Default: true Group: scheduler
-
timeUnit
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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 GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder 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
-
accessToken
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder accessToken(String accessToken)
OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. The option is a:java.lang.String
type. Group: security
-
clientSecret
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder clientSecret(String clientSecret)
Client secret of the mail application. The option is a:java.lang.String
type. Group: security
-
refreshToken
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder refreshToken(String refreshToken)
OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. The option is a:java.lang.String
type. Group: security
-
-