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
Modifier and TypeMethodDescriptionaccessToken
(String accessToken) OAuth 2 access token.advanced()
applicationName
(String applicationName) Google mail application name.backoffErrorThreshold
(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffErrorThreshold
(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffMultiplier
(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.backoffMultiplier
(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.Client ID of the mail application.clientSecret
(String clientSecret) Client secret of the mail application.delay
(long delay) Milliseconds before the next poll.Milliseconds before the next poll.Delegate for wide-domain service account.greedy
(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.initialDelay
(long initialDelay) Milliseconds before the first poll starts.initialDelay
(String initialDelay) Milliseconds before the first poll starts.Comma separated list of labels to take into account.markAsRead
(boolean markAsRead) Mark the message as read once it has been consumed.markAsRead
(String markAsRead) Mark the message as read once it has been consumed.maxResults
(long maxResults) Max results to be returned.maxResults
(String maxResults) Max results to be returned.The query to execute on gmail box.raw
(boolean raw) Whether to store the entire email message in an RFC 2822 formatted and base64url encoded string (in JSon format), in the Camel message body.Whether to store the entire email message in an RFC 2822 formatted and base64url encoded string (in JSon format), in the Camel message body.refreshToken
(String refreshToken) OAuth 2 refresh token.repeatCount
(long repeatCount) Specifies a maximum limit of number of fires.repeatCount
(String repeatCount) Specifies a maximum limit of number of fires.runLoggingLevel
(String runLoggingLevel) The consumer logs a start/complete log line when it polls.runLoggingLevel
(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.scheduledExecutorService
(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.scheduledExecutorService
(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.To use a cron scheduler from either camel-spring or camel-quartz component.To use a cron scheduler from either camel-spring or camel-quartz component.schedulerProperties
(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.schedulerProperties
(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.GMail scopes.GMail scopes.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.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.serviceAccountKey
(String serviceAccountKey) Sets .json file with credentials for Service account.startScheduler
(boolean startScheduler) Whether the scheduler should be auto started.startScheduler
(String startScheduler) Whether the scheduler should be auto started.Time unit for initialDelay and delay options.Time unit for initialDelay and delay options.useFixedDelay
(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.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, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
-
Method Details
-
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- Parameters:
applicationName
- the value to set- Returns:
- the dsl builder
-
clientId
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder clientId(String clientId) Client ID of the mail application. The option is a:java.lang.String
type. Group: consumer- Parameters:
clientId
- the value to set- Returns:
- the dsl builder
-
delegate
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder delegate(String delegate) Delegate for wide-domain service account. The option is a:java.lang.String
type. Group: consumer- Parameters:
delegate
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
labels
- the value to set- Returns:
- the dsl builder
-
markAsRead
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder markAsRead(boolean markAsRead) Mark the message as read once it has been consumed. The option is a:boolean
type. Default: true Group: consumer- Parameters:
markAsRead
- the value to set- Returns:
- the dsl builder
-
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: true Group: consumer- Parameters:
markAsRead
- the value to set- Returns:
- the dsl builder
-
maxResults
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder maxResults(long maxResults) Max results to be returned. The option is a:long
type. Default: 10 Group: consumer- Parameters:
maxResults
- the value to set- Returns:
- the dsl builder
-
maxResults
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder maxResults(String maxResults) Max results to be returned. The option will be converted to along
type. Default: 10 Group: consumer- Parameters:
maxResults
- the value to set- Returns:
- the dsl builder
-
query
The query to execute on gmail box. The option is a:java.lang.String
type. Default: is:unread Group: consumer- Parameters:
query
- the value to set- Returns:
- the dsl builder
-
raw
Whether to store the entire email message in an RFC 2822 formatted and base64url encoded string (in JSon format), in the Camel message body. The option is a:boolean
type. Default: false Group: consumer- Parameters:
raw
- the value to set- Returns:
- the dsl builder
-
raw
Whether to store the entire email message in an RFC 2822 formatted and base64url encoded string (in JSon format), in the Camel message body. The option will be converted to aboolean
type. Default: false Group: consumer- Parameters:
raw
- the value to set- Returns:
- the dsl builder
-
scopes
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder scopes(List<String> scopes) GMail scopes. The option is a:java.util.List<java.lang.String>
type. Group: consumer- Parameters:
scopes
- the value to set- Returns:
- the dsl builder
-
scopes
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder scopes(String scopes) GMail scopes. The option will be converted to ajava.util.List<java.lang.String>
type. Group: consumer- Parameters:
scopes
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
delay
Milliseconds before the next poll. The option is a:long
type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
delay
Milliseconds before the next poll. The option will be converted to along
type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
initialDelay
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder initialDelay(long initialDelay) Milliseconds before the first poll starts. The option is a:long
type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
key
- the option keyvalue
- the option value- Returns:
- the dsl builder
-
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- Parameters:
values
- the values- Returns:
- the dsl builder
-
startScheduler
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder startScheduler(boolean startScheduler) Whether the scheduler should be auto started. The option is a:boolean
type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
accessToken
- the value to set- Returns:
- the dsl builder
-
clientSecret
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder clientSecret(String clientSecret) Client secret of the mail application. The option is a:java.lang.String
type. Group: security- Parameters:
clientSecret
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
refreshToken
- the value to set- Returns:
- the dsl builder
-
serviceAccountKey
default GoogleMailStreamEndpointBuilderFactory.GoogleMailStreamEndpointBuilder serviceAccountKey(String serviceAccountKey) Sets .json file with credentials for Service account. The option is a:java.lang.String
type. Group: security- Parameters:
serviceAccountKey
- the value to set- Returns:
- the dsl builder
-