diff --git a/Home.md b/Home.md index 93a012c..3725a70 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,37 @@ -# Deploy the Project on CamelX Platform +# Google Sheets Source -Deploy on CamelX Platform in three steps +Receive data from Google Sheets. -## Step 1: Create a release -From the project space, click on **"Create a release"** +## Metadata -The new version is automatically available in the list +| Property | Value | +|----------|-------| +| Type | source | +| Group | Google Sheets | +| Namespace | GCP | +| Support Level | Stable | +| Provider | Apache Software Foundation | -## Step 2: Deploy -Click on **"Deploy"** +## Properties -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `spreadsheetId` | string | ✓ | | The Spreadsheet ID to be used as events source | +| `clientId` | string | ✓ | | Client ID of the sheets application | +| `clientSecret` | string | ✓ | | Client Secret of the sheets application | +| `accessToken` | string | ✓ | | OAuth 2 access token for google sheets application. This typically expires after an hour so refreshToken is recommended for long term usage. | +| `refreshToken` | string | ✓ | | 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. | +| `delay` | integer | | `500` | The number of milliseconds before the next poll | +| `repeatCount` | integer | | | Specifies a maximum limit of number of fires | +| `applicationName` | string | | | Google Sheets application name | +| `splitResults` | boolean | | `true` | True if value range result should be split into rows or columns to process each of them individually. | +| `range` | string | | | The range of rows and columns in a sheet to get data from. | +| `majorDimension` | string | | `ROWS` | Specifies the major dimension that the given values should use (ROWS or COLUMNS). | +| `columnNames` | string | | `A` | Optional custom column names that map to cell coordinates based on their position. | -## Step 3: Expose -Enable **"Expose"** +## Dependencies -Choose an **API Gateway** (Internal, Public, etc.) +- `camel:core` +- `camel:jackson` +- `camel:kamelet` +- `camel:google-sheets`