google sheets source Google Sheets Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Receive data from Google Sheets.

Configuration Options

The following table summarizes the configuration options available for the google-sheets-source Kamelet:

Property Name Description Type Default Example

accessToken

Access Token

Required OAuth 2 access token for google sheets application. This typically expires after an hour so refreshToken is recommended for long term usage.

string

clientId

Client Id

Required Client ID of the sheets application.

string

clientSecret

Client Secret

Required Client Secret of the sheets application.

string

refreshToken

Refresh Token

Required OAuth 2 refresh token for google sheets 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

spreadsheetId

Spreadsheet ID

Required The Spreadsheet ID to be used as events source.

string

applicationName

Application name

Google Sheets application name.

string

columnNames

Column Names

Optional custom column names that map to cell coordinates based on their position.

string

A

delay

Delay

The number of milliseconds before the next poll.

integer

500

majorDimension

Major Dimension

Specifies the major dimension that the given values should use (ROWS or COLUMNS).

Enum values:

* COLUMNS * ROWS

string

ROWS

ROWS

range

Cells Range

The range of rows and columns in a sheet to get data from.

string

A1:B3

repeatCount

Repeat Count

Specifies a maximum limit of number of fires.

integer

splitResults

Split Results

True if value range result should be split into rows or columns to process each of them individually.

boolean

true

Dependencies

At runtime, the google-sheets-source Kamelet relies upon the presence of the following dependencies:

  • camel:core

  • camel:jackson

  • camel:kamelet

  • camel:google-sheets

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the google-sheets-source.

Knative source

You can use the google-sheets-source Kamelet as a Knative source by binding it to a Knative object.

google-sheets-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: google-sheets-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: google-sheets-source
    properties:
      accessToken: The Access Token
      clientId: The Client Id
      clientSecret: The Client Secret
      refreshToken: The Refresh Token
      spreadsheetId: The Spreadsheet ID
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the google-sheets-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f google-sheets-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind channel:mychannel -p "source.accessToken=The Access Token" -p "source.clientId=The Client Id" -p "source.clientSecret=The Client Secret" -p "source.refreshToken=The Refresh Token" -p "source.spreadsheetId=The Spreadsheet ID" google-sheets-source

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka source

You can use the google-sheets-source Kamelet as a Kafka source by binding it to a Kafka topic.

google-sheets-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: google-sheets-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: google-sheets-source
    properties:
      accessToken: The Access Token
      clientId: The Client Id
      clientSecret: The Client Secret
      refreshToken: The Refresh Token
      spreadsheetId: The Spreadsheet ID
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the google-sheets-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f google-sheets-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "source.accessToken=The Access Token" -p "source.clientId=The Client Id" -p "source.clientSecret=The Client Secret" -p "source.refreshToken=The Refresh Token" -p "source.spreadsheetId=The Spreadsheet ID" google-sheets-source

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/google-sheets-source.kamelet.yaml

Back to top