Google Calendar

Since Camel 2.15

Both producer and consumer are supported

The Google Calendar component provides access to Google Calendar via the Google Calendar Web APIs.

Google Calendar uses the OAuth 2.0 protocol for authenticating a Google account and authorizing access to user data. Before you can use this component, you will need to create an account and generate OAuth credentials. Credentials comprise of a clientId, clientSecret, and a refreshToken. A handy resource for generating a long-lived refreshToken is the OAuth playground.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
        <groupId>org.apache.camel</groupId>
        <artifactId>camel-google-calendar</artifactId>
        <!-- use the same version as your Camel core version -->
        <version>x.x.x</version>
</dependency>

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

Component Options

The Google Calendar component supports 14 options, which are listed below.

Name Description Default Type

applicationName (common)

Google calendar application name. Example would be camel-google-calendar/1.0.

String

clientId (common)

Client ID of the calendar application.

String

configuration (common)

To use the shared configuration.

GoogleCalendarConfiguration

scopes (common)

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.

https://www.googleapis.com/auth/calendar

String

bridgeErrorHandler (consumer)

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.

false

boolean

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

boolean

clientFactory (advanced)

To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory.

GoogleCalendarClientFactory

accessToken (security)

OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.

String

clientSecret (security)

Client secret of the calendar application.

String

emailAddress (security)

The emailAddress of the Google Service Account.

String

p12FileName (security)

The name of the p12 file which has the private key to use with the Google Service Account.

String

refreshToken (security)

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.

String

user (security)

The email address of the user the application is trying to impersonate in the service account flow.

String

Endpoint Options

The Google Calendar endpoint is configured using URI syntax:

google-calendar:apiName/methodName

with the following path and query parameters:

Path Parameters (2 parameters)

Name Description Default Type

apiName (common)

Required What kind of operation to perform.

Enum values:

  • ACL

  • LIST

  • CALENDARS

  • CHANNELS

  • COLORS

  • FREEBUSY

  • EVENTS

  • SETTINGS

GoogleCalendarApiName

methodName (common)

Required What sub operation to use for the selected operation.

Enum values:

  • calendarImport

  • clear

  • delete

  • get

  • insert

  • instances

  • list

  • move

  • patch

  • query

  • quickAdd

  • stop

  • update

  • watch

String

Query Parameters (30 parameters)

Name Description Default Type

applicationName (common)

Google calendar application name. Example would be camel-google-calendar/1.0.

String

clientId (common)

Client ID of the calendar application.

String

inBody (common)

Sets the name of a parameter to be passed in the exchange In Body.

String

scopes (common)

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.

https://www.googleapis.com/auth/calendar

String

bridgeErrorHandler (consumer)

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.

false

boolean

sendEmptyMessageWhenIdle (consumer)

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.

false

boolean

exceptionHandler (consumer (advanced))

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.

ExceptionHandler

exchangePattern (consumer (advanced))

Sets the exchange pattern when the consumer creates an exchange.

Enum values:

  • InOnly

  • InOut

  • InOptionalOut

ExchangePattern

pollStrategy (consumer (advanced))

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.

PollingConsumerPollStrategy

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

backoffErrorThreshold (scheduler)

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.

int

backoffIdleThreshold (scheduler)

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.

int

backoffMultiplier (scheduler)

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.

int

delay (scheduler)

Milliseconds before the next poll.

500

long

greedy (scheduler)

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

false

boolean

initialDelay (scheduler)

Milliseconds before the first poll starts.

1000

long

repeatCount (scheduler)

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.

0

long

runLoggingLevel (scheduler)

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.

Enum values:

  • TRACE

  • DEBUG

  • INFO

  • WARN

  • ERROR

  • OFF

TRACE

LoggingLevel

scheduledExecutorService (scheduler)

Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.

ScheduledExecutorService

scheduler (scheduler)

To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler.

none

Object

schedulerProperties (scheduler)

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.

Map

startScheduler (scheduler)

Whether the scheduler should be auto started.

true

boolean

timeUnit (scheduler)

Time unit for initialDelay and delay options.

Enum values:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

MILLISECONDS

TimeUnit

useFixedDelay (scheduler)

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

true

boolean

accessToken (security)

OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.

String

clientSecret (security)

Client secret of the calendar application.

String

emailAddress (security)

The emailAddress of the Google Service Account.

String

p12FileName (security)

The name of the p12 file which has the private key to use with the Google Service Account.

String

refreshToken (security)

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.

String

user (security)

The email address of the user the application is trying to impersonate in the service account flow.

String

API Parameters (7 APIs)

The @Google Calendar endpoint is an API based component and has additional parameters based on which API name and API method is used. The API name and API method is located in the endpoint URI as the apiName/methodName path parameters:

google-calendar:apiName/methodName

There are 7 API names as listed in the table below:

API Name Type Description

acl

Both

The acl collection of methods

calendars

Both

The calendars collection of methods

channels

Both

The channels collection of methods

events

Both

The events collection of methods

freebusy

Both

The freebusy collection of methods

list

Both

The calendarList collection of methods

settings

Both

The settings collection of methods

Each API is documented in the following sections to come.

API: acl

Both producer and consumer are supported

The acl API is defined in the syntax as follows:

google-calendar:acl/methodName?[parameters]

The 7 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)

Method Alias Description

delete

Deletes an access control rule

get

Returns an access control rule

insert

Creates an access control rule

list

Returns the rules in the access control list for the calendar

patch

Updates an access control rule

update

Updates an access control rule

watch

Watch for changes to ACL resources

Method delete

Signatures:

  • com.google.api.services.calendar.Calendar.Acl.Delete delete(String calendarId, String ruleId);

The google-calendar/delete API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

ruleId

ACL rule identifier

String

Method get

Signatures:

  • com.google.api.services.calendar.Calendar.Acl.Get get(String calendarId, String ruleId);

The google-calendar/get API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

ruleId

ACL rule identifier

String

Method insert

Signatures:

  • com.google.api.services.calendar.Calendar.Acl.Insert insert(String calendarId, com.google.api.services.calendar.model.AclRule content);

The google-calendar/insert API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

content

The com.google.api.services.calendar.model.AclRule

AclRule

Method list

Signatures:

  • com.google.api.services.calendar.Calendar.Acl.List list(String calendarId);

The google-calendar/list API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

Method patch

Signatures:

  • com.google.api.services.calendar.Calendar.Acl.Patch patch(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content);

The google-calendar/patch API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

content

The com.google.api.services.calendar.model.AclRule

AclRule

ruleId

ACL rule identifier

String

Method update

Signatures:

  • com.google.api.services.calendar.Calendar.Acl.Update update(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content);

The google-calendar/update API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

content

The com.google.api.services.calendar.model.AclRule

AclRule

ruleId

ACL rule identifier

String

Method watch

Signatures:

  • com.google.api.services.calendar.Calendar.Acl.Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content);

The google-calendar/watch API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

contentChannel

The com.google.api.services.calendar.model.Channel

Channel

In addition to the parameters above, the google-calendar API can also use any of the Query Parameters (30 parameters).

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelGoogleCalendar.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelGoogleCalendar.myParameterNameHere header.

API: calendars

Both producer and consumer are supported

The calendars API is defined in the syntax as follows:

google-calendar:calendars/methodName?[parameters]

The 6 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)

Method Alias Description

clear

Clears a primary calendar

delete

Deletes a secondary calendar

get

Returns metadata for a calendar

insert

Creates a secondary calendar

patch

Updates metadata for a calendar

update

Updates metadata for a calendar

Method clear

Signatures:

  • com.google.api.services.calendar.Calendar.Calendars.Clear clear(String calendarId);

The google-calendar/clear API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

Method delete

Signatures:

  • com.google.api.services.calendar.Calendar.Calendars.Delete delete(String calendarId);

The google-calendar/delete API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

Method get

Signatures:

  • com.google.api.services.calendar.Calendar.Calendars.Get get(String calendarId);

The google-calendar/get API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

Method insert

Signatures:

  • com.google.api.services.calendar.Calendar.Calendars.Insert insert(com.google.api.services.calendar.model.Calendar content);

The google-calendar/insert API method has the parameters listed in the table below:

Parameter Description Type

content

The com.google.api.services.calendar.model.Calendar

Calendar

Method patch

Signatures:

  • com.google.api.services.calendar.Calendar.Calendars.Patch patch(String calendarId, com.google.api.services.calendar.model.Calendar content);

The google-calendar/patch API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

content

The com.google.api.services.calendar.model.Calendar

Calendar

Method update

Signatures:

  • com.google.api.services.calendar.Calendar.Calendars.Update update(String calendarId, com.google.api.services.calendar.model.Calendar content);

The google-calendar/update API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

content

The com.google.api.services.calendar.model.Calendar

Calendar

In addition to the parameters above, the google-calendar API can also use any of the Query Parameters (30 parameters).

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelGoogleCalendar.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelGoogleCalendar.myParameterNameHere header.

API: channels

Both producer and consumer are supported

The channels API is defined in the syntax as follows:

google-calendar:channels/methodName?[parameters]

The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)

Method Alias Description

stop

Stop watching resources through this channel

Method stop

Signatures:

  • com.google.api.services.calendar.Calendar.Channels.Stop stop(com.google.api.services.calendar.model.Channel content);

The google-calendar/stop API method has the parameters listed in the table below:

Parameter Description Type

contentChannel

The com.google.api.services.calendar.model.Channel

Channel

In addition to the parameters above, the google-calendar API can also use any of the Query Parameters (30 parameters).

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelGoogleCalendar.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelGoogleCalendar.myParameterNameHere header.

API: events

Both producer and consumer are supported

The events API is defined in the syntax as follows:

google-calendar:events/methodName?[parameters]

The 11 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)

Method Alias Description

calendarImport

Imports an event

delete

Deletes an event

get

Returns an event

insert

Creates an event

instances

Returns instances of the specified recurring event

list

Returns events on the specified calendar

move

Moves an event to another calendar, i

patch

Updates an event

quickAdd

Creates an event based on a simple text string

update

Updates an event

watch

Watch for changes to Events resources

Method calendarImport

Signatures:

  • com.google.api.services.calendar.Calendar.Events.CalendarImport calendarImport(String calendarId, com.google.api.services.calendar.model.Event content);

The google-calendar/calendarImport API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

content

The com.google.api.services.calendar.model.Event

Event

Method delete

Signatures:

  • com.google.api.services.calendar.Calendar.Events.Delete delete(String calendarId, String eventId);

The google-calendar/delete API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

eventId

Event identifier

String

Method get

Signatures:

  • com.google.api.services.calendar.Calendar.Events.Get get(String calendarId, String eventId);

The google-calendar/get API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

eventId

Event identifier

String

Method insert

Signatures:

  • com.google.api.services.calendar.Calendar.Events.Insert insert(String calendarId, com.google.api.services.calendar.model.Event content);

The google-calendar/insert API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

content

The com.google.api.services.calendar.model.Event

Event

Method instances

Signatures:

  • com.google.api.services.calendar.Calendar.Events.Instances instances(String calendarId, String eventId);

The google-calendar/instances API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

eventId

Recurring event identifier

String

Method list

Signatures:

  • com.google.api.services.calendar.Calendar.Events.List list(String calendarId);

The google-calendar/list API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

Method move

Signatures:

  • com.google.api.services.calendar.Calendar.Events.Move move(String calendarId, String eventId, String destination);

The google-calendar/move API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier of the source calendar where the event currently is on

String

destination

Calendar identifier of the target calendar where the event is to be moved to

String

eventId

Event identifier

String

Method patch

Signatures:

  • com.google.api.services.calendar.Calendar.Events.Patch patch(String calendarId, String eventId, com.google.api.services.calendar.model.Event content);

The google-calendar/patch API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

content

The com.google.api.services.calendar.model.Event

Event

eventId

Event identifier

String

Method quickAdd

Signatures:

  • com.google.api.services.calendar.Calendar.Events.QuickAdd quickAdd(String calendarId, String text);

The google-calendar/quickAdd API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

text

The text describing the event to be created

String

Method update

Signatures:

  • com.google.api.services.calendar.Calendar.Events.Update update(String calendarId, String eventId, com.google.api.services.calendar.model.Event content);

The google-calendar/update API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

content

The com.google.api.services.calendar.model.Event

Event

eventId

Event identifier

String

Method watch

Signatures:

  • com.google.api.services.calendar.Calendar.Events.Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content);

The google-calendar/watch API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

contentChannel

The com.google.api.services.calendar.model.Channel

Channel

In addition to the parameters above, the google-calendar API can also use any of the Query Parameters (30 parameters).

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelGoogleCalendar.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelGoogleCalendar.myParameterNameHere header.

API: freebusy

Both producer and consumer are supported

The freebusy API is defined in the syntax as follows:

google-calendar:freebusy/methodName?[parameters]

The 1 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)

Method Alias Description

query

Returns free/busy information for a set of calendars

Method query

Signatures:

  • com.google.api.services.calendar.Calendar.Freebusy.Query query(com.google.api.services.calendar.model.FreeBusyRequest content);

The google-calendar/query API method has the parameters listed in the table below:

Parameter Description Type

content

The com.google.api.services.calendar.model.FreeBusyRequest

FreeBusyRequest

In addition to the parameters above, the google-calendar API can also use any of the Query Parameters (30 parameters).

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelGoogleCalendar.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelGoogleCalendar.myParameterNameHere header.

API: list

Both producer and consumer are supported

The list API is defined in the syntax as follows:

google-calendar:list/methodName?[parameters]

The 6 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)

Method Alias Description

delete

Deletes an entry on the user’s calendar list

get

Returns an entry on the user’s calendar list

insert

Adds an entry to the user’s calendar list

patch

Updates an entry on the user’s calendar list

update

Updates an entry on the user’s calendar list

watch

Watch for changes to CalendarList resources

Method delete

Signatures:

  • com.google.api.services.calendar.Calendar.CalendarList.Delete delete(String calendarId);

The google-calendar/delete API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

Method get

Signatures:

  • com.google.api.services.calendar.Calendar.CalendarList.Get get(String calendarId);

The google-calendar/get API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

Method insert

Signatures:

  • com.google.api.services.calendar.Calendar.CalendarList.Insert insert(com.google.api.services.calendar.model.CalendarListEntry content);

The google-calendar/insert API method has the parameters listed in the table below:

Parameter Description Type

content

The com.google.api.services.calendar.model.CalendarListEntry

CalendarListEntry

Method patch

Signatures:

  • com.google.api.services.calendar.Calendar.CalendarList.Patch patch(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content);

The google-calendar/patch API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

content

The com.google.api.services.calendar.model.CalendarListEntry

CalendarListEntry

Method update

Signatures:

  • com.google.api.services.calendar.Calendar.CalendarList.Update update(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content);

The google-calendar/update API method has the parameters listed in the table below:

Parameter Description Type

calendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the primary keyword.

String

content

The com.google.api.services.calendar.model.CalendarListEntry

CalendarListEntry

Method watch

Signatures:

  • com.google.api.services.calendar.Calendar.CalendarList.Watch watch(com.google.api.services.calendar.model.Channel content);

The google-calendar/watch API method has the parameters listed in the table below:

Parameter Description Type

contentChannel

The com.google.api.services.calendar.model.Channel

Channel

In addition to the parameters above, the google-calendar API can also use any of the Query Parameters (30 parameters).

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelGoogleCalendar.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelGoogleCalendar.myParameterNameHere header.

API: settings

Both producer and consumer are supported

The settings API is defined in the syntax as follows:

google-calendar:settings/methodName?[parameters]

The 2 method(s) is listed in the table below, followed by detailed syntax for each method. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)

Method Alias Description

get

Returns a single user setting

watch

Watch for changes to Settings resources

Method get

Signatures:

  • com.google.api.services.calendar.Calendar.Settings.Get get(String setting);

The google-calendar/get API method has the parameters listed in the table below:

Parameter Description Type

setting

The id of the user setting

String

Method watch

Signatures:

  • com.google.api.services.calendar.Calendar.Settings.Watch watch(com.google.api.services.calendar.model.Channel content);

The google-calendar/watch API method has the parameters listed in the table below:

Parameter Description Type

contentChannel

The com.google.api.services.calendar.model.Channel

Channel

In addition to the parameters above, the google-calendar API can also use any of the Query Parameters (30 parameters).

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelGoogleCalendar.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelGoogleCalendar.myParameterNameHere header.

Spring Boot Auto-Configuration

When using google-calendar with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-google-calendar-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 35 options, which are listed below.

Name Description Default Type

camel.component.google-calendar-stream.access-token

OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.

String

camel.component.google-calendar-stream.application-name

Google Calendar application name. Example would be camel-google-calendar/1.0.

String

camel.component.google-calendar-stream.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.google-calendar-stream.bridge-error-handler

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.

false

Boolean

camel.component.google-calendar-stream.calendar-id

The calendarId to be used.

primary

String

camel.component.google-calendar-stream.client-factory

The client Factory. The option is a org.apache.camel.component.google.calendar.GoogleCalendarClientFactory type.

GoogleCalendarClientFactory

camel.component.google-calendar-stream.client-id

Client ID of the calendar application.

String

camel.component.google-calendar-stream.client-secret

Client secret of the calendar application.

String

camel.component.google-calendar-stream.configuration

The configuration. The option is a org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamConfiguration type.

GoogleCalendarStreamConfiguration

camel.component.google-calendar-stream.consider-last-update

Take into account the lastUpdate of the last event polled as start date for the next poll.

false

Boolean

camel.component.google-calendar-stream.consume-from-now

Consume events in the selected calendar from now on.

true

Boolean

camel.component.google-calendar-stream.email-address

The emailAddress of the Google Service Account.

String

camel.component.google-calendar-stream.enabled

Whether to enable auto configuration of the google-calendar-stream component. This is enabled by default.

Boolean

camel.component.google-calendar-stream.max-results

Max results to be returned.

10

Integer

camel.component.google-calendar-stream.p12-file-name

The name of the p12 file which has the private key to use with the Google Service Account.

String

camel.component.google-calendar-stream.query

The query to execute on calendar.

String

camel.component.google-calendar-stream.refresh-token

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.

String

camel.component.google-calendar-stream.scopes

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.

List

camel.component.google-calendar-stream.sync-flow

Sync events, see https://developers.google.com/calendar/v3/sync Note: not compatible with: 'query' and 'considerLastUpdate' parameters.

false

Boolean

camel.component.google-calendar-stream.user

The email address of the user the application is trying to impersonate in the service account flow.

String

camel.component.google-calendar.access-token

OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.

String

camel.component.google-calendar.application-name

Google calendar application name. Example would be camel-google-calendar/1.0.

String

camel.component.google-calendar.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.google-calendar.bridge-error-handler

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.

false

Boolean

camel.component.google-calendar.client-factory

To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory. The option is a org.apache.camel.component.google.calendar.GoogleCalendarClientFactory type.

GoogleCalendarClientFactory

camel.component.google-calendar.client-id

Client ID of the calendar application.

String

camel.component.google-calendar.client-secret

Client secret of the calendar application.

String

camel.component.google-calendar.configuration

To use the shared configuration. The option is a org.apache.camel.component.google.calendar.GoogleCalendarConfiguration type.

GoogleCalendarConfiguration

camel.component.google-calendar.email-address

The emailAddress of the Google Service Account.

String

camel.component.google-calendar.enabled

Whether to enable auto configuration of the google-calendar component. This is enabled by default.

Boolean

camel.component.google-calendar.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.google-calendar.p12-file-name

The name of the p12 file which has the private key to use with the Google Service Account.

String

camel.component.google-calendar.refresh-token

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.

String

camel.component.google-calendar.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.

https://www.googleapis.com/auth/calendar

String

camel.component.google-calendar.user

The email address of the user the application is trying to impersonate in the service account flow.

String
Back to top