[[google-calendar-stream-component]]
= Google Calendar Stream Component
:docTitle: Google Calendar Stream
:shortname: google-calendar-stream
:artifactId: camel-google-calendar
:description: Poll for changes in a Google Calendar.
:since: 2.23
:supportLevel: Stable
:component-header: Only consumer is supported
//Manually maintained attributes
:group: Google
:camel-spring-boot-name: google-calendar

*Since Camel {since}*

*{component-header}*

The Google Calendar Stream component provides access
to https://calendar.google.com[Calendar] via
the https://developers.google.com/calendar/overview[Google Calendar
Web APIs]. This component provides the streaming feature for Calendar events.

Google Calendar uses
the https://developers.google.com/accounts/docs/OAuth2[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 https://developers.google.com/calendar/auth[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 https://developers.google.com/oauthplayground[OAuth playground].

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

[source,xml]
----
<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>
----

== URI Format

The Google Calendar Component uses the following URI format:

----
google-calendar-stream://index?[options]
----

== Component options


// component options: START
The Google Calendar Stream component supports 19 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *applicationName* (consumer) | Google Calendar application name. Example would be camel-google-calendar/1.0 |  | 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
| *calendarId* (consumer) | The calendarId to be used | primary | String
| *clientId* (consumer) | Client ID of the calendar application |  | String
| *configuration* (consumer) | The configuration |  | GoogleCalendarStreamConfiguration
| *considerLastUpdate* (consumer) | Take into account the lastUpdate of the last event polled as start date for the next poll | false | boolean
| *consumeFromNow* (consumer) | Consume events in the selected calendar from now on | true | boolean
| *maxResults* (consumer) | Max results to be returned | 10 | int
| *query* (consumer) | The query to execute on calendar |  | String
| *scopes* (consumer) | 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
| *syncFlow* (consumer) | Sync events, see \https://developers.google.com/calendar/v3/sync Note: not compatible with: 'query' and 'considerLastUpdate' parameters | 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) | The client Factory |  | 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
|===
// component options: END




// endpoint options: START
The Google Calendar Stream endpoint is configured using URI syntax:

----
google-calendar-stream:index
----

with the following path and query parameters:

=== Path Parameters (1 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *index* | *Required* Specifies an index for the endpoint |  | String
|===


=== Query Parameters (34 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *applicationName* (consumer) | Google Calendar application name. Example would be camel-google-calendar/1.0 |  | 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
| *calendarId* (consumer) | The calendarId to be used | primary | String
| *clientId* (consumer) | Client ID of the calendar application |  | String
| *considerLastUpdate* (consumer) | Take into account the lastUpdate of the last event polled as start date for the next poll | false | boolean
| *consumeFromNow* (consumer) | Consume events in the selected calendar from now on | true | boolean
| *maxResults* (consumer) | Max results to be returned | 10 | int
| *query* (consumer) | The query to execute on calendar |  | String
| *scopes* (consumer) | 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
| *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
| *syncFlow* (consumer) | Sync events, see \https://developers.google.com/calendar/v3/sync Note: not compatible with: 'query' and 'considerLastUpdate' parameters | false | boolean
| *exceptionHandler* (consumer) | 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) | Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut |  | ExchangePattern
| *pollStrategy* (consumer) | 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
| *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. There are 6 enums and the value can be one of: 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. There are 7 enums and the value can be one of: 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 Stream 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 null path parameters:

----
google-calendar-stream:index
----

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

[width="100%",cols="2,2,6",options="header"]
|===
| API Name | Type | Description
| *acl* | Consumer | The acl collection of methods
| *calendars* | Consumer | The calendars collection of methods
| *channels* | Consumer | The channels collection of methods
| *events* | Consumer | The events collection of methods
| *freebusy* | Consumer | The freebusy collection of methods
| *list* | Consumer | The calendarList collection of methods
| *settings* | Consumer | The settings collection of methods
|===

Each API is documented in the following sections to come.


==== API: acl

*Only consumer is supported*




The acl API has 7 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):

[source,java]
----

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

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

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

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

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

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

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

----

The acl API is defined in the syntax as follows:

----
google-calendar-stream:acl/methodName?[parameters]
----

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

[width="100%",cols="2,2,6",options="header"]
|===
| 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
|===

The acl API method(s) has the following set of parameters listed in the table below:
[width="100%",cols="2,2,4,2",options="header"]
|===
| Method | Parameter | Description | Type
| delete | *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
| delete | *ruleId* |  ACL rule identifier | String
| get | *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
| get | *ruleId* |  ACL rule identifier | String
| insert | *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
| insert | *content* |  The com.google.api.services.calendar.model.AclRule | AclRule
| list | *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
| patch | *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
| patch | *content* |  The com.google.api.services.calendar.model.AclRule | AclRule
| patch | *ruleId* |  ACL rule identifier | String
| update | *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
| update | *content* |  The com.google.api.services.calendar.model.AclRule | AclRule
| update | *ruleId* |  ACL rule identifier | String
| watch | *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
| watch | *contentChannel* |  The com.google.api.services.calendar.model.Channel | Channel
|===

In addition to the parameters above, the acl API can also use from the 34 endpoint query option
which is listed in the _Query Parameters_ section.

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 `CamelGoogleCalendarStream.parameter`.
The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
would override a `CamelGoogleCalendarStream.myParameterNameHere` header.



==== API: calendars

*Only consumer is supported*




The calendars API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):

[source,java]
----

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

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

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

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

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

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

----

The calendars API is defined in the syntax as follows:

----
google-calendar-stream:calendars/methodName?[parameters]
----

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

[width="100%",cols="2,2,6",options="header"]
|===
| 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
|===

The calendars API method(s) has the following set of parameters listed in the table below:
[width="100%",cols="2,2,4,2",options="header"]
|===
| Method | Parameter | Description | Type
| clear | *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
| delete | *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
| get | *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
| insert | *content* |  The com.google.api.services.calendar.model.Calendar | Calendar
| patch | *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
| patch | *content* |  The com.google.api.services.calendar.model.Calendar | Calendar
| update | *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
| update | *content* |  The com.google.api.services.calendar.model.Calendar | Calendar
|===

In addition to the parameters above, the calendars API can also use from the 34 endpoint query option
which is listed in the _Query Parameters_ section.

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 `CamelGoogleCalendarStream.parameter`.
The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
would override a `CamelGoogleCalendarStream.myParameterNameHere` header.



==== API: channels

*Only consumer is supported*




The channels API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):

[source,java]
----

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

----

The channels API is defined in the syntax as follows:

----
google-calendar-stream:channels/methodName?[parameters]
----

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

[width="100%",cols="2,2,6",options="header"]
|===
| Method | Alias | Description
| *stop* |  | Stop watching resources through this channel
|===

The channels API method(s) has the following set of parameters listed in the table below:
[width="100%",cols="2,2,4,2",options="header"]
|===
| Method | Parameter | Description | Type
| stop | *contentChannel* |  The com.google.api.services.calendar.model.Channel | Channel
|===

In addition to the parameters above, the channels API can also use from the 34 endpoint query option
which is listed in the _Query Parameters_ section.

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 `CamelGoogleCalendarStream.parameter`.
The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
would override a `CamelGoogleCalendarStream.myParameterNameHere` header.



==== API: events

*Only consumer is supported*




The events API has 11 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):

[source,java]
----

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

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

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

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

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

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

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

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

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

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

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

----

The events API is defined in the syntax as follows:

----
google-calendar-stream:events/methodName?[parameters]
----

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

[width="100%",cols="2,2,6",options="header"]
|===
| 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
|===

The events API method(s) has the following set of parameters listed in the table below:
[width="100%",cols="2,2,4,2",options="header"]
|===
| Method | Parameter | Description | Type
| calendarImport | *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
| calendarImport | *content* |  The com.google.api.services.calendar.model.Event | Event
| delete | *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
| delete | *eventId* |  Event identifier | String
| get | *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
| get | *eventId* |  Event identifier | String
| insert | *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
| insert | *content* |  The com.google.api.services.calendar.model.Event | Event
| instances | *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
| instances | *eventId* |  Recurring event identifier | String
| list | *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
| move | *calendarId* |  Calendar identifier of the source calendar where the event currently is on | String
| move | *destination* |  Calendar identifier of the target calendar where the event is to be moved to | String
| move | *eventId* |  Event identifier | String
| patch | *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
| patch | *content* |  The com.google.api.services.calendar.model.Event | Event
| patch | *eventId* |  Event identifier | String
| quickAdd | *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
| quickAdd | *text* |  The text describing the event to be created | String
| update | *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
| update | *content* |  The com.google.api.services.calendar.model.Event | Event
| update | *eventId* |  Event identifier | String
| watch | *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
| watch | *contentChannel* |  The com.google.api.services.calendar.model.Channel | Channel
|===

In addition to the parameters above, the events API can also use from the 34 endpoint query option
which is listed in the _Query Parameters_ section.

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 `CamelGoogleCalendarStream.parameter`.
The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
would override a `CamelGoogleCalendarStream.myParameterNameHere` header.



==== API: freebusy

*Only consumer is supported*




The freebusy API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):

[source,java]
----

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

----

The freebusy API is defined in the syntax as follows:

----
google-calendar-stream:freebusy/methodName?[parameters]
----

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

[width="100%",cols="2,2,6",options="header"]
|===
| Method | Alias | Description
| *query* |  | Returns free/busy information for a set of calendars
|===

The freebusy API method(s) has the following set of parameters listed in the table below:
[width="100%",cols="2,2,4,2",options="header"]
|===
| Method | Parameter | Description | Type
| query | *content* |  The com.google.api.services.calendar.model.FreeBusyRequest | FreeBusyRequest
|===

In addition to the parameters above, the freebusy API can also use from the 34 endpoint query option
which is listed in the _Query Parameters_ section.

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 `CamelGoogleCalendarStream.parameter`.
The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
would override a `CamelGoogleCalendarStream.myParameterNameHere` header.



==== API: list

*Only consumer is supported*




The list API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):

[source,java]
----

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

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

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

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

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

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

----

The list API is defined in the syntax as follows:

----
google-calendar-stream:list/methodName?[parameters]
----

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

[width="100%",cols="2,2,6",options="header"]
|===
| 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
|===

The list API method(s) has the following set of parameters listed in the table below:
[width="100%",cols="2,2,4,2",options="header"]
|===
| Method | Parameter | Description | Type
| delete | *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
| get | *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
| insert | *content* |  The com.google.api.services.calendar.model.CalendarListEntry | CalendarListEntry
| patch | *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
| patch | *content* |  The com.google.api.services.calendar.model.CalendarListEntry | CalendarListEntry
| update | *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
| update | *content* |  The com.google.api.services.calendar.model.CalendarListEntry | CalendarListEntry
| watch | *contentChannel* |  The com.google.api.services.calendar.model.Channel | Channel
|===

In addition to the parameters above, the list API can also use from the 34 endpoint query option
which is listed in the _Query Parameters_ section.

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 `CamelGoogleCalendarStream.parameter`.
The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
would override a `CamelGoogleCalendarStream.myParameterNameHere` header.



==== API: settings

*Only consumer is supported*




The settings API has 2 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):

[source,java]
----

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

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

----

The settings API is defined in the syntax as follows:

----
google-calendar-stream:settings/methodName?[parameters]
----

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

[width="100%",cols="2,2,6",options="header"]
|===
| Method | Alias | Description
| *get* |  | Returns a single user setting
| *watch* |  | Watch for changes to Settings resources
|===

The settings API method(s) has the following set of parameters listed in the table below:
[width="100%",cols="2,2,4,2",options="header"]
|===
| Method | Parameter | Description | Type
| get | *setting* |  The id of the user setting | String
| watch | *contentChannel* |  The com.google.api.services.calendar.model.Channel | Channel
|===

In addition to the parameters above, the settings API can also use from the 34 endpoint query option
which is listed in the _Query Parameters_ section.

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 `CamelGoogleCalendarStream.parameter`.
The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
would override a `CamelGoogleCalendarStream.myParameterNameHere` header.
// endpoint options: END


include::spring-boot:partial$starter.adoc[]
