This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 8116a34 CAMEL-16897: camel-google-sheets - The stream component is
not API based. Also fixed spreadsheetId should be required and moved from query
to path.
8116a34 is described below
commit 8116a34031a6bd84e3589804d24470ce6d4cf906
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Mon Aug 30 10:35:18 2021 +0200
CAMEL-16897: camel-google-sheets - The stream component is not API based.
Also fixed spreadsheetId should be required and moved from query to path.
---
.../catalog/components/google-sheets-stream.json | 8 ++---
.../GoogleSheetsStreamComponentConfigurer.java | 6 ----
.../GoogleSheetsStreamEndpointConfigurer.java | 6 ----
.../GoogleSheetsStreamEndpointUriFactory.java | 7 ++--
.../google/sheets/stream/google-sheets-stream.json | 8 ++---
.../main/docs/google-sheets-stream-component.adoc | 16 ++++-----
.../sheets/stream/GoogleSheetsStreamComponent.java | 1 +
.../stream/GoogleSheetsStreamConfiguration.java | 18 +---------
.../sheets/stream/GoogleSheetsStreamEndpoint.java | 4 +--
.../SheetsStreamConsumerIntegrationTest.java | 2 +-
.../component/ComponentsBuilderFactory.java | 2 +-
.../GoogleSheetsStreamComponentBuilderFactory.java | 19 +----------
.../src/generated/resources/metadata.json | 4 +--
.../builder/endpoint/StaticEndpointBuilders.java | 22 +++++++------
.../GoogleSheetsStreamEndpointBuilderFactory.java | 38 +++++++---------------
.../ROOT/pages/google-sheets-stream-component.adoc | 16 ++++-----
.../ROOT/pages/camel-3x-upgrade-guide-3_12.adoc | 7 ++++
17 files changed, 63 insertions(+), 121 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/google-sheets-stream.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/google-sheets-stream.json
index 1ed6dcc..7974ceb 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/google-sheets-stream.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/google-sheets-stream.json
@@ -6,7 +6,7 @@
"description": "Poll for changes in Google Sheets.",
"deprecated": false,
"firstVersion": "2.23.0",
- "label": "api,cloud,sheets",
+ "label": "cloud,sheets",
"javaType":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamComponent",
"supportLevel": "Stable",
"groupId": "org.apache.camel",
@@ -14,7 +14,7 @@
"version": "3.12.0-SNAPSHOT",
"scheme": "google-sheets-stream",
"extendsScheme": "",
- "syntax": "google-sheets-stream:apiName",
+ "syntax": "google-sheets-stream:spreadsheetId",
"async": false,
"api": false,
"consumerOnly": true,
@@ -33,7 +33,6 @@
"range": { "kind": "property", "displayName": "Range", "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": "Specifies the range of
rows and columns in a sheet to get data from." },
"scopes": { "kind": "property", "displayName": "Scopes", "group":
"consumer", "label": "", "required": false, "type": "array", "javaType":
"java.util.List<java.lang.String>", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration",
"configurationField": "configuration", "description": "Specifies the level of
permissions you want a sheets application to have to a user account. See [...]
"splitResults": { "kind": "property", "displayName": "Split Results",
"group": "consumer", "label": "", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration",
"configurationField": "configuration", "description": "True if value range
result should be split into rows or columns to process each of [...]
- "spreadsheetId": { "kind": "property", "displayName": "Spreadsheet Id",
"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": "Specifies the
spreadsheet identifier that is used to identify the target to obtain." },
"valueRenderOption": { "kind": "property", "displayName": "Value Render
Option", "group": "consumer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "FORMATTED_VALUE",
"UNFORMATTED_VALUE", "FORMULA" ], "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "FORMATTED_VALUE", "configurationClass":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration",
"configurationField": "configuration", "des [...]
"autowiredEnabled": { "kind": "property", "displayName": "Autowired
Enabled", "group": "advanced", "label": "advanced", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "description": "Whether autowiring is
enabled. This is used for automatic autowiring options (the option must be
marked as autowired) by looking up in the registry to find if there is a single
instance of matching type, which t [...]
"clientFactory": { "kind": "property", "displayName": "Client Factory",
"group": "advanced", "label": "advanced", "required": false, "type": "object",
"javaType":
"org.apache.camel.component.google.sheets.GoogleSheetsClientFactory",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use the GoogleSheetsClientFactory as factory for creating the client. Will by
default use BatchGoogleSheetsClientFactory" },
@@ -42,7 +41,7 @@
"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 [...]
},
"properties": {
- "apiName": { "kind": "path", "displayName": "Api Name", "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": "Sets the apiName." },
+ "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" },
"bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error
Handler", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Allows for bridging the
consumer to the Camel routing Error Handler, which mean any exceptions occurred
while the consumer is trying to pickup incoming messages, or the likes, will
now be processed as a m [...]
"clientId": { "kind": "parameter", "displayName": "Client Id", "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": "Client ID of the sheets
application" },
@@ -53,7 +52,6 @@
"scopes": { "kind": "parameter", "displayName": "Scopes", "group":
"consumer", "label": "", "required": false, "type": "array", "javaType":
"java.util.List<java.lang.String>", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration",
"configurationField": "configuration", "description": "Specifies the level of
permissions you want a sheets application to have to a user account. Se [...]
"sendEmptyMessageWhenIdle": { "kind": "parameter", "displayName": "Send
Empty Message When Idle", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description": "If
the polling consumer did not poll any files, you can enable this option to send
an empty message (no body) instead." },
"splitResults": { "kind": "parameter", "displayName": "Split Results",
"group": "consumer", "label": "", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration",
"configurationField": "configuration", "description": "True if value range
result should be split into rows or columns to process each o [...]
- "spreadsheetId": { "kind": "parameter", "displayName": "Spreadsheet Id",
"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": "Specifies the
spreadsheet identifier that is used to identify the target to obtain." },
"valueRenderOption": { "kind": "parameter", "displayName": "Value Render
Option", "group": "consumer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "FORMATTED_VALUE",
"UNFORMATTED_VALUE", "FORMULA" ], "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "FORMATTED_VALUE", "configurationClass":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration",
"configurationField": "configuration", "de [...]
"exceptionHandler": { "kind": "parameter", "displayName": "Exception
Handler", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By default the
con [...]
"exchangePattern": { "kind": "parameter", "displayName": "Exchange
Pattern", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut",
"InOptionalOut" ], "deprecated": false, "autowired": false, "secret": false,
"description": "Sets the exchange pattern when the consumer creates an
exchange." },
diff --git
a/components/camel-google/camel-google-sheets/src/generated/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamComponentConfigurer.java
b/components/camel-google/camel-google-sheets/src/generated/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamComponentConfigurer.java
index 3c11d4e..8c0ae6d 100644
---
a/components/camel-google/camel-google-sheets/src/generated/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamComponentConfigurer.java
+++
b/components/camel-google/camel-google-sheets/src/generated/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamComponentConfigurer.java
@@ -55,8 +55,6 @@ public class GoogleSheetsStreamComponentConfigurer extends
PropertyConfigurerSup
case "scopes":
getOrCreateConfiguration(target).setScopes(property(camelContext,
java.util.List.class, value)); return true;
case "splitresults":
case "splitResults":
getOrCreateConfiguration(target).setSplitResults(property(camelContext,
boolean.class, value)); return true;
- case "spreadsheetid":
- case "spreadsheetId":
getOrCreateConfiguration(target).setSpreadsheetId(property(camelContext,
java.lang.String.class, value)); return true;
case "valuerenderoption":
case "valueRenderOption":
getOrCreateConfiguration(target).setValueRenderOption(property(camelContext,
java.lang.String.class, value)); return true;
default: return false;
@@ -93,8 +91,6 @@ public class GoogleSheetsStreamComponentConfigurer extends
PropertyConfigurerSup
case "scopes": return java.util.List.class;
case "splitresults":
case "splitResults": return boolean.class;
- case "spreadsheetid":
- case "spreadsheetId": return java.lang.String.class;
case "valuerenderoption":
case "valueRenderOption": return java.lang.String.class;
default: return null;
@@ -132,8 +128,6 @@ public class GoogleSheetsStreamComponentConfigurer extends
PropertyConfigurerSup
case "scopes": return getOrCreateConfiguration(target).getScopes();
case "splitresults":
case "splitResults": return
getOrCreateConfiguration(target).isSplitResults();
- case "spreadsheetid":
- case "spreadsheetId": return
getOrCreateConfiguration(target).getSpreadsheetId();
case "valuerenderoption":
case "valueRenderOption": return
getOrCreateConfiguration(target).getValueRenderOption();
default: return null;
diff --git
a/components/camel-google/camel-google-sheets/src/generated/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamEndpointConfigurer.java
b/components/camel-google/camel-google-sheets/src/generated/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamEndpointConfigurer.java
index 7e8e5e2..840297c 100644
---
a/components/camel-google/camel-google-sheets/src/generated/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamEndpointConfigurer.java
+++
b/components/camel-google/camel-google-sheets/src/generated/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamEndpointConfigurer.java
@@ -70,8 +70,6 @@ public class GoogleSheetsStreamEndpointConfigurer extends
PropertyConfigurerSupp
case "sendEmptyMessageWhenIdle":
target.setSendEmptyMessageWhenIdle(property(camelContext, boolean.class,
value)); return true;
case "splitresults":
case "splitResults":
target.getConfiguration().setSplitResults(property(camelContext, boolean.class,
value)); return true;
- case "spreadsheetid":
- case "spreadsheetId":
target.getConfiguration().setSpreadsheetId(property(camelContext,
java.lang.String.class, value)); return true;
case "startscheduler":
case "startScheduler": target.setStartScheduler(property(camelContext,
boolean.class, value)); return true;
case "timeunit":
@@ -136,8 +134,6 @@ public class GoogleSheetsStreamEndpointConfigurer extends
PropertyConfigurerSupp
case "sendEmptyMessageWhenIdle": return boolean.class;
case "splitresults":
case "splitResults": return boolean.class;
- case "spreadsheetid":
- case "spreadsheetId": return java.lang.String.class;
case "startscheduler":
case "startScheduler": return boolean.class;
case "timeunit":
@@ -203,8 +199,6 @@ public class GoogleSheetsStreamEndpointConfigurer extends
PropertyConfigurerSupp
case "sendEmptyMessageWhenIdle": return
target.isSendEmptyMessageWhenIdle();
case "splitresults":
case "splitResults": return target.getConfiguration().isSplitResults();
- case "spreadsheetid":
- case "spreadsheetId": return
target.getConfiguration().getSpreadsheetId();
case "startscheduler":
case "startScheduler": return target.isStartScheduler();
case "timeunit":
diff --git
a/components/camel-google/camel-google-sheets/src/generated/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamEndpointUriFactory.java
b/components/camel-google/camel-google-sheets/src/generated/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamEndpointUriFactory.java
index 151d2a2..014d75b 100644
---
a/components/camel-google/camel-google-sheets/src/generated/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamEndpointUriFactory.java
+++
b/components/camel-google/camel-google-sheets/src/generated/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamEndpointUriFactory.java
@@ -15,14 +15,13 @@ import org.apache.camel.spi.EndpointUriFactory;
*/
public class GoogleSheetsStreamEndpointUriFactory extends
org.apache.camel.support.component.EndpointUriFactorySupport implements
EndpointUriFactory {
- private static final String BASE = ":apiName";
+ private static final String BASE = ":spreadsheetId";
private static final Set<String> PROPERTY_NAMES;
private static final Set<String> SECRET_PROPERTY_NAMES;
static {
- Set<String> props = new HashSet<>(42);
+ Set<String> props = new HashSet<>(41);
props.add("backoffMultiplier");
- props.add("apiName");
props.add("majorDimension");
props.add("batchClearValuesRequest");
props.add("values");
@@ -83,7 +82,7 @@ public class GoogleSheetsStreamEndpointUriFactory extends
org.apache.camel.suppo
Map<String, Object> copy = new HashMap<>(properties);
- uri = buildPathParameter(syntax, uri, "apiName", null, true, copy);
+ uri = buildPathParameter(syntax, uri, "spreadsheetId", null, true,
copy);
uri = buildQueryParameters(uri, copy, encode);
return uri;
}
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 1ed6dcc..7974ceb 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
@@ -6,7 +6,7 @@
"description": "Poll for changes in Google Sheets.",
"deprecated": false,
"firstVersion": "2.23.0",
- "label": "api,cloud,sheets",
+ "label": "cloud,sheets",
"javaType":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamComponent",
"supportLevel": "Stable",
"groupId": "org.apache.camel",
@@ -14,7 +14,7 @@
"version": "3.12.0-SNAPSHOT",
"scheme": "google-sheets-stream",
"extendsScheme": "",
- "syntax": "google-sheets-stream:apiName",
+ "syntax": "google-sheets-stream:spreadsheetId",
"async": false,
"api": false,
"consumerOnly": true,
@@ -33,7 +33,6 @@
"range": { "kind": "property", "displayName": "Range", "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": "Specifies the range of
rows and columns in a sheet to get data from." },
"scopes": { "kind": "property", "displayName": "Scopes", "group":
"consumer", "label": "", "required": false, "type": "array", "javaType":
"java.util.List<java.lang.String>", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration",
"configurationField": "configuration", "description": "Specifies the level of
permissions you want a sheets application to have to a user account. See [...]
"splitResults": { "kind": "property", "displayName": "Split Results",
"group": "consumer", "label": "", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration",
"configurationField": "configuration", "description": "True if value range
result should be split into rows or columns to process each of [...]
- "spreadsheetId": { "kind": "property", "displayName": "Spreadsheet Id",
"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": "Specifies the
spreadsheet identifier that is used to identify the target to obtain." },
"valueRenderOption": { "kind": "property", "displayName": "Value Render
Option", "group": "consumer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "FORMATTED_VALUE",
"UNFORMATTED_VALUE", "FORMULA" ], "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "FORMATTED_VALUE", "configurationClass":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration",
"configurationField": "configuration", "des [...]
"autowiredEnabled": { "kind": "property", "displayName": "Autowired
Enabled", "group": "advanced", "label": "advanced", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "description": "Whether autowiring is
enabled. This is used for automatic autowiring options (the option must be
marked as autowired) by looking up in the registry to find if there is a single
instance of matching type, which t [...]
"clientFactory": { "kind": "property", "displayName": "Client Factory",
"group": "advanced", "label": "advanced", "required": false, "type": "object",
"javaType":
"org.apache.camel.component.google.sheets.GoogleSheetsClientFactory",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use the GoogleSheetsClientFactory as factory for creating the client. Will by
default use BatchGoogleSheetsClientFactory" },
@@ -42,7 +41,7 @@
"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 [...]
},
"properties": {
- "apiName": { "kind": "path", "displayName": "Api Name", "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": "Sets the apiName." },
+ "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" },
"bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error
Handler", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Allows for bridging the
consumer to the Camel routing Error Handler, which mean any exceptions occurred
while the consumer is trying to pickup incoming messages, or the likes, will
now be processed as a m [...]
"clientId": { "kind": "parameter", "displayName": "Client Id", "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": "Client ID of the sheets
application" },
@@ -53,7 +52,6 @@
"scopes": { "kind": "parameter", "displayName": "Scopes", "group":
"consumer", "label": "", "required": false, "type": "array", "javaType":
"java.util.List<java.lang.String>", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration",
"configurationField": "configuration", "description": "Specifies the level of
permissions you want a sheets application to have to a user account. Se [...]
"sendEmptyMessageWhenIdle": { "kind": "parameter", "displayName": "Send
Empty Message When Idle", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description": "If
the polling consumer did not poll any files, you can enable this option to send
an empty message (no body) instead." },
"splitResults": { "kind": "parameter", "displayName": "Split Results",
"group": "consumer", "label": "", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration",
"configurationField": "configuration", "description": "True if value range
result should be split into rows or columns to process each o [...]
- "spreadsheetId": { "kind": "parameter", "displayName": "Spreadsheet Id",
"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": "Specifies the
spreadsheet identifier that is used to identify the target to obtain." },
"valueRenderOption": { "kind": "parameter", "displayName": "Value Render
Option", "group": "consumer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "enum": [ "FORMATTED_VALUE",
"UNFORMATTED_VALUE", "FORMULA" ], "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "FORMATTED_VALUE", "configurationClass":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration",
"configurationField": "configuration", "de [...]
"exceptionHandler": { "kind": "parameter", "displayName": "Exception
Handler", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By default the
con [...]
"exchangePattern": { "kind": "parameter", "displayName": "Exchange
Pattern", "group": "consumer (advanced)", "label": "consumer,advanced",
"required": false, "type": "object", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut",
"InOptionalOut" ], "deprecated": false, "autowired": false, "secret": false,
"description": "Sets the exchange pattern when the consumer creates an
exchange." },
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 cdb5509..8961c3c 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
@@ -90,7 +90,7 @@ The following two sections lists all the options, firstly for
the component foll
== Component Options
-The Google Sheets Stream component supports 17 options, which are listed below.
+The Google Sheets Stream component supports 16 options, which are listed below.
@@ -107,7 +107,6 @@ The Google Sheets Stream component supports 17 options,
which are listed below.
| *range* (consumer) | Specifies the range of rows and columns in a sheet to
get data from. | | String
| *scopes* (consumer) | Specifies the level of permissions you want a sheets
application to have to a user account. See
\https://developers.google.com/identity/protocols/googlescopes for more info. |
| List
| *splitResults* (consumer) | True if value range result should be split into
rows or columns to process each of them individually. When true each row or
column is represented with a separate exchange in batch processing. Otherwise
value range object is used as exchange junk size. | false | boolean
-| *spreadsheetId* (consumer) | Specifies the spreadsheet identifier that is
used to identify the target to obtain. | | String
| *valueRenderOption* (consumer) | Determines how values should be rendered in
the output. There are 3 enums and the value can be one of: FORMATTED_VALUE,
UNFORMATTED_VALUE, FORMULA | FORMATTED_VALUE | String
| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used
for automatic autowiring options (the option must be marked as autowired) by
looking up in the registry to find if there is a single instance of matching
type, which then gets configured on the component. This can be used for
automatic configuring JDBC data sources, JMS connection factories, AWS Clients,
etc. | true | boolean
| *clientFactory* (advanced) | To use the GoogleSheetsClientFactory as factory
for creating the client. Will by default use BatchGoogleSheetsClientFactory |
| GoogleSheetsClientFactory
@@ -123,7 +122,7 @@ The Google Sheets Stream component supports 17 options,
which are listed below.
The Google Sheets Stream endpoint is configured using URI syntax:
----
-google-sheets-stream:apiName
+google-sheets-stream:spreadsheetId
----
with the following path and query parameters:
@@ -134,11 +133,11 @@ with the following path and query parameters:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *apiName* | *Required* Sets the apiName. | | String
+| *spreadsheetId* | *Required* Specifies the spreadsheet identifier that is
used to identify the target to obtain. | | String
|===
-=== Query Parameters (32 parameters):
+=== Query Parameters (31 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
@@ -154,7 +153,6 @@ with the following path and query parameters:
| *scopes* (consumer) | Specifies the level of permissions you want a sheets
application to have to a user account. See
\https://developers.google.com/identity/protocols/googlescopes for more info. |
| List
| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll
any files, you can enable this option to send an empty message (no body)
instead. | false | boolean
| *splitResults* (consumer) | True if value range result should be split into
rows or columns to process each of them individually. When true each row or
column is represented with a separate exchange in batch processing. Otherwise
value range object is used as exchange junk size. | false | boolean
-| *spreadsheetId* (consumer) | Specifies the spreadsheet identifier that is
used to identify the target to obtain. | | String
| *valueRenderOption* (consumer) | Determines how values should be rendered in
the output. There are 3 enums and the value can be one of: FORMATTED_VALUE,
UNFORMATTED_VALUE, FORMULA | FORMATTED_VALUE | String
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. There are 3 enums and the value can be one of: InOnly,
InOut, InOptionalOut | | ExchangePattern
@@ -187,7 +185,7 @@ The Google Sheets Stream endpoint is an API based component
and has additional p
The API name and API method is located in the endpoint URI as the null path
parameters:
----
-google-sheets-stream:apiName
+google-sheets-stream:spreadsheetId
----
There are 2 API names as listed in the table below:
@@ -289,7 +287,7 @@ The data API method(s) has the following set of parameters
listed in the table b
| update | *values* | The com.google.api.services.sheets.v4.model.ValueRange
| ValueRange
|===
-In addition to the parameters above, the data API can also use from the 32
endpoint query option
+In addition to the parameters above, the data API can also use from the 31
endpoint query option
which is listed in the _Query Parameters_ section.
Any of the parameters can be provided in either the endpoint URI, or
dynamically in a message header.
@@ -352,7 +350,7 @@ The spreadsheets API method(s) has the following set of
parameters listed in the
| getByDataFilter | *spreadsheetId* | The spreadsheet to request | String
|===
-In addition to the parameters above, the spreadsheets API can also use from
the 32 endpoint query option
+In addition to the parameters above, the spreadsheets API can also use from
the 31 endpoint query option
which is listed in the _Query Parameters_ section.
Any of the parameters can be provided in either the endpoint URI, or
dynamically in a message header.
diff --git
a/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamComponent.java
b/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamComponent.java
index 43dbaa4..ea3a9f0 100644
---
a/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamComponent.java
+++
b/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamComponent.java
@@ -89,6 +89,7 @@ public class GoogleSheetsStreamComponent extends
DefaultComponent {
@Override
protected Endpoint createEndpoint(String uri, String remaining,
Map<String, Object> parameters) throws Exception {
final GoogleSheetsStreamConfiguration configuration =
this.configuration.copy();
+ configuration.setSpreadsheetId(remaining);
GoogleSheetsStreamEndpoint endpoint = new
GoogleSheetsStreamEndpoint(uri, this, configuration);
setProperties(endpoint, parameters);
return endpoint;
diff --git
a/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamConfiguration.java
b/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamConfiguration.java
index f651861..573b16e 100644
---
a/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamConfiguration.java
+++
b/components/camel-google/camel-google-sheets/src/main/java/org/apache/camel/component/google/sheets/stream/GoogleSheetsStreamConfiguration.java
@@ -36,7 +36,7 @@ public class GoogleSheetsStreamConfiguration implements
Cloneable {
@UriPath
@Metadata(required = true)
- private String apiName;
+ private String spreadsheetId;
@UriParam
private List<String> scopes = DEFAULT_SCOPES;
@UriParam
@@ -50,8 +50,6 @@ public class GoogleSheetsStreamConfiguration implements
Cloneable {
@UriParam
private String applicationName;
@UriParam
- private String spreadsheetId;
- @UriParam
private int maxResults;
@UriParam
private String range;
@@ -132,20 +130,6 @@ public class GoogleSheetsStreamConfiguration implements
Cloneable {
this.scopes = scopes;
}
- /**
- * Gets the apiName.
- */
- public String getApiName() {
- return apiName;
- }
-
- /**
- * Sets the apiName.
- */
- public void setApiName(String apiName) {
- this.apiName = apiName;
- }
-
public String getSpreadsheetId() {
return spreadsheetId;
}
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 c17f148..6fa2507 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
@@ -32,9 +32,9 @@ import org.apache.camel.support.ScheduledPollEndpoint;
@UriEndpoint(firstVersion = "2.23.0",
scheme = "google-sheets-stream",
title = "Google Sheets Stream",
- syntax = "google-sheets-stream:apiName", apiSyntax = "apiName",
+ syntax = "google-sheets-stream:spreadsheetId",
consumerOnly = true,
- category = { Category.API, Category.CLOUD, Category.SHEETS })
+ category = { Category.CLOUD, Category.SHEETS })
public class GoogleSheetsStreamEndpoint extends ScheduledPollEndpoint {
@UriParam
diff --git
a/components/camel-google/camel-google-sheets/src/test/java/org/apache/camel/component/google/sheets/stream/SheetsStreamConsumerIntegrationTest.java
b/components/camel-google/camel-google-sheets/src/test/java/org/apache/camel/component/google/sheets/stream/SheetsStreamConsumerIntegrationTest.java
index 6216f42..dee0f57 100644
---
a/components/camel-google/camel-google-sheets/src/test/java/org/apache/camel/component/google/sheets/stream/SheetsStreamConsumerIntegrationTest.java
+++
b/components/camel-google/camel-google-sheets/src/test/java/org/apache/camel/component/google/sheets/stream/SheetsStreamConsumerIntegrationTest.java
@@ -159,7 +159,7 @@ public class SheetsStreamConsumerIntegrationTest extends
AbstractGoogleSheetsStr
@Override
public void configure() {
from(String.format(
-
"google-sheets-stream://data?spreadsheetId=%s&range=%s&delay=20000&maxResults=5&splitResults=%s",
+
"google-sheets-stream://%s?range=%s&delay=20000&maxResults=5&splitResults=%s",
spreadsheetId, range, splitResults))
.routeId("google-stream-test")
.to("mock:result");
diff --git
a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
index 59ffca1..3bbd779 100644
---
a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
+++
b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
@@ -1725,7 +1725,7 @@ public interface ComponentsBuilderFactory {
* Google Sheets Stream (camel-google-sheets)
* Poll for changes in Google Sheets.
*
- * Category: api,cloud,sheets
+ * Category: cloud,sheets
* Since: 2.23
* Maven coordinates: org.apache.camel:camel-google-sheets
*
diff --git
a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/GoogleSheetsStreamComponentBuilderFactory.java
b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/GoogleSheetsStreamComponentBuilderFactory.java
index 89a24f1..20a2c11 100644
---
a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/GoogleSheetsStreamComponentBuilderFactory.java
+++
b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/GoogleSheetsStreamComponentBuilderFactory.java
@@ -34,7 +34,7 @@ public interface GoogleSheetsStreamComponentBuilderFactory {
* Google Sheets Stream (camel-google-sheets)
* Poll for changes in Google Sheets.
*
- * Category: api,cloud,sheets
+ * Category: cloud,sheets
* Since: 2.23
* Maven coordinates: org.apache.camel:camel-google-sheets
*
@@ -220,22 +220,6 @@ public interface GoogleSheetsStreamComponentBuilderFactory
{
return this;
}
/**
- * Specifies the spreadsheet identifier that is used to identify the
- * target to obtain.
- *
- * The option is a: <code>java.lang.String</code> type.
- *
- * Group: consumer
- *
- * @param spreadsheetId the value to set
- * @return the dsl builder
- */
- default GoogleSheetsStreamComponentBuilder spreadsheetId(
- java.lang.String spreadsheetId) {
- doSetProperty("spreadsheetId", spreadsheetId);
- return this;
- }
- /**
* Determines how values should be rendered in the output.
*
* The option is a: <code>java.lang.String</code> type.
@@ -371,7 +355,6 @@ public interface GoogleSheetsStreamComponentBuilderFactory {
case "range":
getOrCreateConfiguration((GoogleSheetsStreamComponent)
component).setRange((java.lang.String) value); return true;
case "scopes":
getOrCreateConfiguration((GoogleSheetsStreamComponent)
component).setScopes((java.util.List) value); return true;
case "splitResults":
getOrCreateConfiguration((GoogleSheetsStreamComponent)
component).setSplitResults((boolean) value); return true;
- case "spreadsheetId":
getOrCreateConfiguration((GoogleSheetsStreamComponent)
component).setSpreadsheetId((java.lang.String) value); return true;
case "valueRenderOption":
getOrCreateConfiguration((GoogleSheetsStreamComponent)
component).setValueRenderOption((java.lang.String) value); return true;
case "autowiredEnabled": ((GoogleSheetsStreamComponent)
component).setAutowiredEnabled((boolean) value); return true;
case "clientFactory": ((GoogleSheetsStreamComponent)
component).setClientFactory((org.apache.camel.component.google.sheets.GoogleSheetsClientFactory)
value); return true;
diff --git a/core/camel-componentdsl/src/generated/resources/metadata.json
b/core/camel-componentdsl/src/generated/resources/metadata.json
index d8cd7e6..b7beca2 100644
--- a/core/camel-componentdsl/src/generated/resources/metadata.json
+++ b/core/camel-componentdsl/src/generated/resources/metadata.json
@@ -2803,7 +2803,7 @@
"description": "Poll for changes in Google Sheets.",
"deprecated": false,
"firstVersion": "2.23.0",
- "label": "api,cloud,sheets",
+ "label": "cloud,sheets",
"javaType":
"org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamComponent",
"supportLevel": "Stable",
"groupId": "org.apache.camel",
@@ -2811,7 +2811,7 @@
"version": "3.12.0-SNAPSHOT",
"scheme": "google-sheets-stream",
"extendsScheme": "",
- "syntax": "google-sheets-stream:apiName",
+ "syntax": "google-sheets-stream:spreadsheetId",
"async": false,
"api": false,
"consumerOnly": true,
diff --git
a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
index f761195..97a100c 100644
---
a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
+++
b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
@@ -5866,16 +5866,17 @@ public class StaticEndpointBuilders {
* Google Sheets Stream (camel-google-sheets)
* Poll for changes in Google Sheets.
*
- * Category: api,cloud,sheets
+ * Category: cloud,sheets
* Since: 2.23
* Maven coordinates: org.apache.camel:camel-google-sheets
*
- * Syntax: <code>google-sheets-stream:apiName</code>
+ * Syntax: <code>google-sheets-stream:spreadsheetId</code>
*
- * Path parameter: apiName (required)
- * Sets the apiName.
+ * Path parameter: spreadsheetId (required)
+ * Specifies the spreadsheet identifier that is used to identify the target
+ * to obtain.
*
- * @param path apiName
+ * @param path spreadsheetId
* @return the dsl builder
*/
public static
org.apache.camel.builder.endpoint.dsl.GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder
googleSheetsStream(
@@ -5886,18 +5887,19 @@ public class StaticEndpointBuilders {
* Google Sheets Stream (camel-google-sheets)
* Poll for changes in Google Sheets.
*
- * Category: api,cloud,sheets
+ * Category: cloud,sheets
* Since: 2.23
* Maven coordinates: org.apache.camel:camel-google-sheets
*
- * Syntax: <code>google-sheets-stream:apiName</code>
+ * Syntax: <code>google-sheets-stream:spreadsheetId</code>
*
- * Path parameter: apiName (required)
- * Sets the apiName.
+ * Path parameter: spreadsheetId (required)
+ * Specifies the spreadsheet identifier that is used to identify the target
+ * to obtain.
*
* @param componentName to use a custom component name for the endpoint
* instead of the default name
- * @param path apiName
+ * @param path spreadsheetId
* @return the dsl builder
*/
public static
org.apache.camel.builder.endpoint.dsl.GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder
googleSheetsStream(
diff --git
a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GoogleSheetsStreamEndpointBuilderFactory.java
b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GoogleSheetsStreamEndpointBuilderFactory.java
index 579921a..df11ee8 100644
---
a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GoogleSheetsStreamEndpointBuilderFactory.java
+++
b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GoogleSheetsStreamEndpointBuilderFactory.java
@@ -328,22 +328,6 @@ public interface GoogleSheetsStreamEndpointBuilderFactory {
return this;
}
/**
- * Specifies the spreadsheet identifier that is used to identify the
- * target to obtain.
- *
- * The option is a: <code>java.lang.String</code> type.
- *
- * Group: consumer
- *
- * @param spreadsheetId the value to set
- * @return the dsl builder
- */
- default GoogleSheetsStreamEndpointBuilder spreadsheetId(
- String spreadsheetId) {
- doSetProperty("spreadsheetId", spreadsheetId);
- return this;
- }
- /**
* Determines how values should be rendered in the output.
*
* The option is a: <code>java.lang.String</code> type.
@@ -1010,16 +994,17 @@ public interface
GoogleSheetsStreamEndpointBuilderFactory {
* Google Sheets Stream (camel-google-sheets)
* Poll for changes in Google Sheets.
*
- * Category: api,cloud,sheets
+ * Category: cloud,sheets
* Since: 2.23
* Maven coordinates: org.apache.camel:camel-google-sheets
*
- * Syntax: <code>google-sheets-stream:apiName</code>
+ * Syntax: <code>google-sheets-stream:spreadsheetId</code>
*
- * Path parameter: apiName (required)
- * Sets the apiName.
+ * Path parameter: spreadsheetId (required)
+ * Specifies the spreadsheet identifier that is used to identify the
+ * target to obtain.
*
- * @param path apiName
+ * @param path spreadsheetId
* @return the dsl builder
*/
default GoogleSheetsStreamEndpointBuilder googleSheetsStream(String
path) {
@@ -1029,18 +1014,19 @@ public interface
GoogleSheetsStreamEndpointBuilderFactory {
* Google Sheets Stream (camel-google-sheets)
* Poll for changes in Google Sheets.
*
- * Category: api,cloud,sheets
+ * Category: cloud,sheets
* Since: 2.23
* Maven coordinates: org.apache.camel:camel-google-sheets
*
- * Syntax: <code>google-sheets-stream:apiName</code>
+ * Syntax: <code>google-sheets-stream:spreadsheetId</code>
*
- * Path parameter: apiName (required)
- * Sets the apiName.
+ * Path parameter: spreadsheetId (required)
+ * Specifies the spreadsheet identifier that is used to identify the
+ * target to obtain.
*
* @param componentName to use a custom component name for the endpoint
* instead of the default name
- * @param path apiName
+ * @param path spreadsheetId
* @return the dsl builder
*/
default GoogleSheetsStreamEndpointBuilder googleSheetsStream(
diff --git
a/docs/components/modules/ROOT/pages/google-sheets-stream-component.adoc
b/docs/components/modules/ROOT/pages/google-sheets-stream-component.adoc
index acc747a..67d6b5b 100644
--- a/docs/components/modules/ROOT/pages/google-sheets-stream-component.adoc
+++ b/docs/components/modules/ROOT/pages/google-sheets-stream-component.adoc
@@ -92,7 +92,7 @@ The following two sections lists all the options, firstly for
the component foll
== Component Options
-The Google Sheets Stream component supports 17 options, which are listed below.
+The Google Sheets Stream component supports 16 options, which are listed below.
@@ -109,7 +109,6 @@ The Google Sheets Stream component supports 17 options,
which are listed below.
| *range* (consumer) | Specifies the range of rows and columns in a sheet to
get data from. | | String
| *scopes* (consumer) | Specifies the level of permissions you want a sheets
application to have to a user account. See
\https://developers.google.com/identity/protocols/googlescopes for more info. |
| List
| *splitResults* (consumer) | True if value range result should be split into
rows or columns to process each of them individually. When true each row or
column is represented with a separate exchange in batch processing. Otherwise
value range object is used as exchange junk size. | false | boolean
-| *spreadsheetId* (consumer) | Specifies the spreadsheet identifier that is
used to identify the target to obtain. | | String
| *valueRenderOption* (consumer) | Determines how values should be rendered in
the output. There are 3 enums and the value can be one of: FORMATTED_VALUE,
UNFORMATTED_VALUE, FORMULA | FORMATTED_VALUE | String
| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used
for automatic autowiring options (the option must be marked as autowired) by
looking up in the registry to find if there is a single instance of matching
type, which then gets configured on the component. This can be used for
automatic configuring JDBC data sources, JMS connection factories, AWS Clients,
etc. | true | boolean
| *clientFactory* (advanced) | To use the GoogleSheetsClientFactory as factory
for creating the client. Will by default use BatchGoogleSheetsClientFactory |
| GoogleSheetsClientFactory
@@ -125,7 +124,7 @@ The Google Sheets Stream component supports 17 options,
which are listed below.
The Google Sheets Stream endpoint is configured using URI syntax:
----
-google-sheets-stream:apiName
+google-sheets-stream:spreadsheetId
----
with the following path and query parameters:
@@ -136,11 +135,11 @@ with the following path and query parameters:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *apiName* | *Required* Sets the apiName. | | String
+| *spreadsheetId* | *Required* Specifies the spreadsheet identifier that is
used to identify the target to obtain. | | String
|===
-=== Query Parameters (32 parameters):
+=== Query Parameters (31 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
@@ -156,7 +155,6 @@ with the following path and query parameters:
| *scopes* (consumer) | Specifies the level of permissions you want a sheets
application to have to a user account. See
\https://developers.google.com/identity/protocols/googlescopes for more info. |
| List
| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll
any files, you can enable this option to send an empty message (no body)
instead. | false | boolean
| *splitResults* (consumer) | True if value range result should be split into
rows or columns to process each of them individually. When true each row or
column is represented with a separate exchange in batch processing. Otherwise
value range object is used as exchange junk size. | false | boolean
-| *spreadsheetId* (consumer) | Specifies the spreadsheet identifier that is
used to identify the target to obtain. | | String
| *valueRenderOption* (consumer) | Determines how values should be rendered in
the output. There are 3 enums and the value can be one of: FORMATTED_VALUE,
UNFORMATTED_VALUE, FORMULA | FORMATTED_VALUE | String
| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. There are 3 enums and the value can be one of: InOnly,
InOut, InOptionalOut | | ExchangePattern
@@ -189,7 +187,7 @@ The Google Sheets Stream endpoint is an API based component
and has additional p
The API name and API method is located in the endpoint URI as the null path
parameters:
----
-google-sheets-stream:apiName
+google-sheets-stream:spreadsheetId
----
There are 2 API names as listed in the table below:
@@ -291,7 +289,7 @@ The data API method(s) has the following set of parameters
listed in the table b
| update | *values* | The com.google.api.services.sheets.v4.model.ValueRange
| ValueRange
|===
-In addition to the parameters above, the data API can also use from the 32
endpoint query option
+In addition to the parameters above, the data API can also use from the 31
endpoint query option
which is listed in the _Query Parameters_ section.
Any of the parameters can be provided in either the endpoint URI, or
dynamically in a message header.
@@ -354,7 +352,7 @@ The spreadsheets API method(s) has the following set of
parameters listed in the
| getByDataFilter | *spreadsheetId* | The spreadsheet to request | String
|===
-In addition to the parameters above, the spreadsheets API can also use from
the 32 endpoint query option
+In addition to the parameters above, the spreadsheets API can also use from
the 31 endpoint query option
which is listed in the _Query Parameters_ section.
Any of the parameters can be provided in either the endpoint URI, or
dynamically in a message header.
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_12.adoc
b/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_12.adoc
index 6f1e243..7c95ece 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_12.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_12.adoc
@@ -43,6 +43,13 @@ The `camel-jms` component now better support Apache Artemis
in streaming mode fo
when Artemis is using a pooled connection pool (previously pooled was not
supported). Now the option `artemisStreamingEnabled`
must explicit be set to `true` to enable support for Artemis streaming mode.
Previously Camel tried to auto-detect this.
+=== camel-google-sheets
+
+The `google-sheets-stream` component has changed the syntax, from:
`google-sheets-stream:apiName` to: `google-sheets-stream:spreadsheetId`
+
+The old `apiName` option was not in use, and therefore it has been replaced
with `spreadsheetId`
+which used to be query parameter.
+
=== camel-kamelet / route templates
Kamelet parameters that are named such as `host`, `port` are now always used
with their configured value.
