docs/components/modules/spring-boot/partials/google-calendar-starter.adoc - camel-spring-boot - Git at Google

 // spring-boot-auto-configure options: START
 :page-partial:
 :doctitle: Camel Spring Boot Starter for google-calendar

 == 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:

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


 [width="100%",cols="2,5,^1,2",options="header"]
 |===
 | 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
 |===
 // spring-boot-auto-configure options: END
	// spring-boot-auto-configure options: START
	:page-partial:
	:doctitle: Camel Spring Boot Starter for google-calendar

	== 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:

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



	[width="100%",cols="2,5,^1,2",options="header"]
	\|===
	\| 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
	\|===
	// spring-boot-auto-configure options: END