2 Home
gitea_admin edited this page 2026-03-11 14:38:15 +00:00

Google Calendar Stream

Poll for changes in a Google Calendar.

Metadata

Property Value
Scheme google-calendar-stream
Support Level Stable
Labels cloud
Version 4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-google-calendar</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name Type Required Default Description
index string Specifies an index for the endpoint
applicationName string Google Calendar application name. Example would be camel-google-calendar/1.0
calendarId string primary The calendarId to be used
clientId string Client ID of the calendar application
considerLastUpdate boolean false Take into account the lastUpdate of the last event polled as start date for the next poll
consumeFromNow boolean true Consume events in the selected calendar from now on
delegate string Delegate for wide-domain service account
maxResults integer 10 Max results to be returned
query string The query to execute on calendar
scopes array Specifies the level of permissions you want a calendar application to have to a user account. See https://developers.google.com/calendar/auth for more info.
sendEmptyMessageWhenIdle boolean false If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
syncFlow boolean false Sync events, see https://developers.google.com/calendar/v3/sync Note: not compatible with: 'query' and 'considerLastUpdate' parameters
bridgeErrorHandler boolean false Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.
exceptionHandler object To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
exchangePattern object Sets the exchange pattern when the consumer creates an exchange.
pollStrategy object A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
backoffErrorThreshold integer The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
backoffIdleThreshold integer The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
backoffMultiplier integer 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.
delay integer 500 Milliseconds before the next poll.
greedy boolean false If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
initialDelay integer 1000 Milliseconds before the first poll starts.
repeatCount integer 0 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.
runLoggingLevel object TRACE The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
scheduledExecutorService object Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
scheduler object none To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler
schedulerProperties object To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
startScheduler boolean true Whether the scheduler should be auto started.
timeUnit object MILLISECONDS Time unit for initialDelay and delay options.
useFixedDelay boolean true Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
accessToken string OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.
clientSecret string Client secret of the calendar application
emailAddress string The emailAddress of the Google Service Account.
p12FileName string The name of the p12 file which has the private key to use with the Google Service Account.
refreshToken string 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.
serviceAccountKey string Service account key in json format to authenticate an application as a service account. Accept base64 adding the prefix base64:
user string The email address of the user the application is trying to impersonate in the service account flow.