blob: d3285cd7363ec8029f287974716ca6cb9531edcf [file] [log] [blame]
// kafka-connector options: START
[[camel-google-calendar-kafka-connector-sink]]
= camel-google-calendar-kafka-connector sink configuration
When using camel-google-calendar-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-google-calendar-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-google-calendar sink connector supports 19 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.apiName* | What kind of operation to perform One of: [ACL] [LIST] [CALENDARS] [CHANNELS] [COLORS] [FREEBUSY] [EVENTS] [SETTINGS] | null | HIGH
| *camel.sink.path.methodName* | What sub operation to use for the selected operation One of: [calendarImport] [clear] [delete] [get] [insert] [instances] [list] [move] [patch] [query] [quickAdd] [stop] [update] [watch] | null | HIGH
| *camel.sink.endpoint.accessToken* | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. | null | MEDIUM
| *camel.sink.endpoint.applicationName* | Google calendar application name. Example would be camel-google-calendar/1.0 | null | MEDIUM
| *camel.sink.endpoint.clientId* | Client ID of the calendar application | null | MEDIUM
| *camel.sink.endpoint.clientSecret* | Client secret of the calendar application | null | MEDIUM
| *camel.sink.endpoint.emailAddress* | The emailAddress of the Google Service Account. | null | MEDIUM
| *camel.sink.endpoint.inBody* | Sets the name of a parameter to be passed in the exchange In Body | null | MEDIUM
| *camel.sink.endpoint.p12FileName* | The name of the p12 file which has the private key to use with the Google Service Account. | null | MEDIUM
| *camel.sink.endpoint.refreshToken* | 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. | null | MEDIUM
| *camel.sink.endpoint.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" | MEDIUM
| *camel.sink.endpoint.user* | The email address of the user the application is trying to impersonate in the service account flow | null | MEDIUM
| *camel.sink.endpoint.lazyStartProducer* | 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 | MEDIUM
| *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.component.google-calendar.configuration* | To use the shared configuration | null | MEDIUM
| *camel.component.google-calendar.lazyStartProducer* | 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 | MEDIUM
| *camel.component.google-calendar.basicProperty Binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.component.google-calendar.clientFactory* | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory | null | MEDIUM
|===
// kafka-connector options: END