blob: 814069401e62467cd7a0deed6c4226a97e56071d [file] [log] [blame]
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
= image:kamelets/google-calendar-source.svg[] Google Calendar Source
*Provided by: "Apache Software Foundation"*
Receive data from Google Calendar.
== Configuration Options
The following table summarizes the configuration options available for the `google-calendar-source` Kamelet:
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
|===
| Property| Name| Description| Type| Default| Example
| *accessToken {empty}* *| Access Token| OAuth 2 access token for google calendar application. This typically expires after an hour so refreshToken is recommended for long term usage.| string| |
| *applicationName {empty}* *| Application name| Google Calendar application name| string| |
| *calendarId {empty}* *| Calendar ID| The calendar ID to be used as events source| string| |
| *clientId {empty}* *| Client Id| Client ID of the calendar application| string| |
| *clientSecret {empty}* *| Client Secret| Client Secret of the calendar application| string| |
| *index {empty}* *| Index| An index for the google calendar endpoint| string| |
| *refreshToken {empty}* *| Refresh Token| OAuth 2 refresh token for google calendar application. 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| |
| consumeFromNow| Consume from now| Consume events in the selected calendar from now on| boolean| `true`|
| delay| Delay| Milliseconds before the next poll| integer| `500`|
| syncFlow| Sync Flow| Sync events for incremental synchronization| boolean| `false`|
|===
NOTE: Fields marked with ({empty}*) are mandatory.
== Usage
This section summarizes how the `google-calendar-source` can be used in various contexts.
=== Knative Source
The `google-calendar-source` Kamelet can be used as Knative source by binding it to a Knative object.
.google-calendar-source-binding.yaml
[source,yaml]
----
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: google-calendar-source-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: google-calendar-source
properties:
accessToken: "The Access Token"
applicationName: "The Application name"
calendarId: "The Calendar ID"
clientId: "The Client Id"
clientSecret: "The Client Secret"
index: "The Index"
refreshToken: "The Refresh Token"
sink:
ref:
kind: InMemoryChannel
apiVersion: messaging.knative.dev/v1
name: mychannel
----
Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to.
Save the `google-calendar-source-binding.yaml` file into your hard drive, then configure it according to your needs.
You can run the source using the following command:
[source,shell]
----
kubectl apply -f google-calendar-source-binding.yaml
----
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT