blob: d20fcbede9269f9383c6baa84fc6842c6ac81dd4 [file] [log] [blame]
// spring-boot-auto-configure options: START
:page-partial:
:doctitle: Camel Spring Boot Starter for google-drive
== Spring Boot Auto-Configuration
When using google-drive 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-drive-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
----
The component supports 12 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *camel.component.google-drive.access-token* | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. | | String
| *camel.component.google-drive.application-name* | Google drive application name. Example would be camel-google-drive/1.0 | | String
| *camel.component.google-drive.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-drive.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-drive.client-factory* | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory. The option is a org.apache.camel.component.google.drive.GoogleDriveClientFactory type. | | GoogleDriveClientFactory
| *camel.component.google-drive.client-id* | Client ID of the drive application | | String
| *camel.component.google-drive.client-secret* | Client secret of the drive application | | String
| *camel.component.google-drive.configuration* | To use the shared configuration. The option is a org.apache.camel.component.google.drive.GoogleDriveConfiguration type. | | GoogleDriveConfiguration
| *camel.component.google-drive.enabled* | Whether to enable auto configuration of the google-drive component. This is enabled by default. | | Boolean
| *camel.component.google-drive.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-drive.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-drive.scopes* | Specifies the level of permissions you want a drive application to have to a user account. See \https://developers.google.com/drive/web/scopes for more info. | | List
|===
// spring-boot-auto-configure options: END