You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by nf...@apache.org on 2022/03/22 16:52:00 UTC
[camel] 11/14: CAMEL-17792: Add doc about the message headers of camel-google-sheets
This is an automated email from the ASF dual-hosted git repository.
nfilotto pushed a commit to branch CAMEL-17792/doc-message-headers
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 443c5a23d85eb25cc7a8c2b67994937fa83ac839
Author: Nicolas Filotto <nf...@talend.com>
AuthorDate: Tue Mar 22 15:36:47 2022 +0100
CAMEL-17792: Add doc about the message headers of camel-google-sheets
---
.../component/google/sheets/stream/google-sheets-stream.json | 8 ++++++++
.../src/main/docs/google-sheets-stream-component.adoc | 3 +++
.../google/sheets/stream/GoogleSheetsStreamConstants.java | 9 +++++++++
.../google/sheets/stream/GoogleSheetsStreamEndpoint.java | 2 +-
4 files changed, 21 insertions(+), 1 deletion(-)
diff --git a/components/camel-google/camel-google-sheets/src/generated/resources/org/apache/camel/component/google/sheets/stream/google-sheets-stream.json b/components/camel-google/camel-google-sheets/src/generated/resources/org/apache/camel/component/google/sheets/stream/google-sheets-stream.json
index f05c99b..4380e7d 100644
--- a/components/camel-google/camel-google-sheets/src/generated/resources/org/apache/camel/component/google/sheets/stream/google-sheets-stream.json
+++ b/components/camel-google/camel-google-sheets/src/generated/resources/org/apache/camel/component/google/sheets/stream/google-sheets-stream.json
@@ -42,6 +42,14 @@
"keyResource": { "kind": "property", "displayName": "Key Resource", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration", "configurationField": "configuration", "description": "Sets .json file with credentials for Service account" },
"refreshToken": { "kind": "property", "displayName": "Refresh Token", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration", "configurationField": "configuration", "description": "OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessTo [...]
},
+ "headers": {
+ "CamelGoogleSheetsSpreadsheetId": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Specifies the spreadsheet identifier that is used to identify the target to obtain." },
+ "CamelGoogleSheetsSpreadsheetUrl": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The URL of the spreadsheet." },
+ "CamelGoogleSheetsMajorDimension": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The major dimension of the values" },
+ "CamelGoogleSheetsRange": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The range the values cover, in A1 notation." },
+ "CamelGoogleSheetsRangeIndex": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The index of the range" },
+ "CamelGoogleSheetsValueIndex": { "kind": "header", "displayName": "", "group": "consumer", "label": "", "required": false, "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The index of the value" }
+ },
"properties": {
"spreadsheetId": { "kind": "path", "displayName": "Spreadsheet Id", "group": "consumer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration", "configurationField": "configuration", "description": "Specifies the spreadsheet identifier that is used to identify the target to o [...]
"applicationName": { "kind": "parameter", "displayName": "Application Name", "group": "consumer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration", "configurationField": "configuration", "description": "Google sheets application name. Example would be camel-google-sheets\/1.0" },
diff --git a/components/camel-google/camel-google-sheets/src/main/docs/google-sheets-stream-component.adoc b/components/camel-google/camel-google-sheets/src/main/docs/google-sheets-stream-component.adoc
index e281149..cf969cb 100644
--- a/components/camel-google/camel-google-sheets/src/main/docs/google-sheets-stream-component.adoc
+++ b/components/camel-google/camel-google-sheets/src/main/docs/google-sheets-stream-component.adoc
@@ -69,6 +69,9 @@ include::partial$component-endpoint-options.adoc[]
// endpoint options: START
// endpoint options: END
+// component headers: START
+include::partial$component-endpoint-headers.adoc[]
+// component headers: END
== More information
diff --git a/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamConstants.java b/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamConstants.java
index a2f69c7..d57deb1 100644
--- a/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamConstants.java
+++ b/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamConstants.java
@@ -16,6 +16,8 @@
*/
package org.apache.camel.component.google.sheets.stream;
+import org.apache.camel.spi.Metadata;
+
/**
* Constants used in Camel Google Sheets Stream
*/
@@ -23,11 +25,18 @@ public final class GoogleSheetsStreamConstants {
private static final String PROPERTY_PREFIX = "CamelGoogleSheets";
+ @Metadata(description = "Specifies the spreadsheet identifier that is used to identify the target to obtain.",
+ javaType = "String")
public static final String SPREADSHEET_ID = PROPERTY_PREFIX + "SpreadsheetId";
+ @Metadata(description = "The URL of the spreadsheet.", javaType = "String")
public static final String SPREADSHEET_URL = PROPERTY_PREFIX + "SpreadsheetUrl";
+ @Metadata(description = "The major dimension of the values", javaType = "String")
public static final String MAJOR_DIMENSION = PROPERTY_PREFIX + "MajorDimension";
+ @Metadata(description = "The range the values cover, in A1 notation.", javaType = "String")
public static final String RANGE = PROPERTY_PREFIX + "Range";
+ @Metadata(description = "The index of the range", javaType = "int")
public static final String RANGE_INDEX = PROPERTY_PREFIX + "RangeIndex";
+ @Metadata(description = "The index of the value", javaType = "int")
public static final String VALUE_INDEX = PROPERTY_PREFIX + "ValueIndex";
/**
diff --git a/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamEndpoint.java b/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamEndpoint.java
index 6fa2507..517a60d 100644
--- a/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamEndpoint.java
+++ b/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamEndpoint.java
@@ -34,7 +34,7 @@ import org.apache.camel.support.ScheduledPollEndpoint;
title = "Google Sheets Stream",
syntax = "google-sheets-stream:spreadsheetId",
consumerOnly = true,
- category = { Category.CLOUD, Category.SHEETS })
+ category = { Category.CLOUD, Category.SHEETS }, headersClass = GoogleSheetsStreamConstants.class)
public class GoogleSheetsStreamEndpoint extends ScheduledPollEndpoint {
@UriParam