Interface GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointBuilder
- Enclosing interface:
- GoogleCalendarEndpointBuilderFactory
public static interface GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Google Calendar component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
accessToken(String accessToken)
OAuth 2 access token.default GoogleCalendarEndpointBuilderFactory.AdvancedGoogleCalendarEndpointConsumerBuilder
advanced()
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
applicationName(String applicationName)
Google calendar application name.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
backoffErrorThreshold(int backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
backoffErrorThreshold(String backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
backoffIdleThreshold(int backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
backoffIdleThreshold(String backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
backoffMultiplier(int backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
backoffMultiplier(String backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
clientId(String clientId)
Client ID of the calendar application.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
clientSecret(String clientSecret)
Client secret of the calendar application.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
delay(long delay)
Milliseconds before the next poll.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
delay(String delay)
Milliseconds before the next poll.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
emailAddress(String emailAddress)
The emailAddress of the Google Service Account.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
greedy(boolean greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
greedy(String greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
inBody(String inBody)
Sets the name of a parameter to be passed in the exchange In Body.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
initialDelay(long initialDelay)
Milliseconds before the first poll starts.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
initialDelay(String initialDelay)
Milliseconds before the first poll starts.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
p12FileName(String p12FileName)
The name of the p12 file which has the private key to use with the Google Service Account.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
refreshToken(String refreshToken)
OAuth 2 refresh token.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
repeatCount(long repeatCount)
Specifies a maximum limit of number of fires.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
repeatCount(String repeatCount)
Specifies a maximum limit of number of fires.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
runLoggingLevel(String runLoggingLevel)
The consumer logs a start/complete log line when it polls.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
The consumer logs a start/complete log line when it polls.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
scheduledExecutorService(String scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
scheduler(String scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
schedulerProperties(String key, Object value)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
schedulerProperties(Map values)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
scopes(String scopes)
Specifies the level of permissions you want a calendar application to have to a user account.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
startScheduler(boolean startScheduler)
Whether the scheduler should be auto started.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
startScheduler(String startScheduler)
Whether the scheduler should be auto started.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
timeUnit(String timeUnit)
Time unit for initialDelay and delay options.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
timeUnit(TimeUnit timeUnit)
Time unit for initialDelay and delay options.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
useFixedDelay(boolean useFixedDelay)
Controls if fixed delay or fixed rate is used.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
useFixedDelay(String useFixedDelay)
Controls if fixed delay or fixed rate is used.default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder
user(String user)
The email address of the user the application is trying to impersonate in the service account flow.
-
-
-
Method Detail
-
advanced
default GoogleCalendarEndpointBuilderFactory.AdvancedGoogleCalendarEndpointConsumerBuilder advanced()
-
applicationName
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder applicationName(String applicationName)
Google calendar application name. Example would be camel-google-calendar/1.0. The option is a:java.lang.String
type. Group: common
-
clientId
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder clientId(String clientId)
Client ID of the calendar application. The option is a:java.lang.String
type. Group: common
-
emailAddress
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder emailAddress(String emailAddress)
The emailAddress of the Google Service Account. The option is a:java.lang.String
type. Group: common
-
inBody
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder inBody(String inBody)
Sets the name of a parameter to be passed in the exchange In Body. The option is a:java.lang.String
type. Group: common
-
p12FileName
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder p12FileName(String p12FileName)
The name of the p12 file which has the private key to use with the Google Service Account. The option is a:java.lang.String
type. Group: common
-
scopes
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder scopes(String scopes)
Specifies the level of permissions you want a calendar application to have to a user account. You can separate multiple scopes by comma. See https://developers.google.com/google-apps/calendar/auth for more info. The option is a:java.lang.String
type. Default: https://www.googleapis.com/auth/calendar Group: common
-
user
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder user(String user)
The email address of the user the application is trying to impersonate in the service account flow. The option is a:java.lang.String
type. Group: common
-
bridgeErrorHandler
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder delay(long delay)
Milliseconds before the next poll. The option is a:long
type. Default: 500 Group: scheduler
-
delay
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder delay(String delay)
Milliseconds before the next poll. The option will be converted to along
type. Default: 500 Group: scheduler
-
greedy
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder initialDelay(long initialDelay)
Milliseconds before the first poll starts. The option is a:long
type. Default: 1000 Group: scheduler
-
initialDelay
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder initialDelay(String initialDelay)
Milliseconds before the first poll starts. The option will be converted to along
type. Default: 1000 Group: scheduler
-
repeatCount
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder scheduler(String scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component. The option is a:java.lang.String
type. Default: none Group: scheduler
-
schedulerProperties
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder startScheduler(boolean startScheduler)
Whether the scheduler should be auto started. The option is a:boolean
type. Default: true Group: scheduler
-
startScheduler
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder startScheduler(String startScheduler)
Whether the scheduler should be auto started. The option will be converted to aboolean
type. Default: true Group: scheduler
-
timeUnit
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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 GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder clientSecret(String clientSecret)
Client secret of the calendar application. The option is a:java.lang.String
type. Group: security
-
refreshToken
default GoogleCalendarEndpointBuilderFactory.GoogleCalendarEndpointConsumerBuilder 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
-
-