Chapter 126. Google Sheets Stream Component
Chapter 126. Google Sheets Stream Component Available as of Camel version 2.23 The Google Sheets component provides access to Sheets via the Google Sheets Web APIs . Google Sheets uses the OAuth 2.0 protocol for authenticating a Google account and authorizing access to user data. Before you can use this component, you will need to create an account and generate OAuth credentials . Credentials comprise of a clientId, clientSecret, and a refreshToken. A handy resource for generating a long-lived refreshToken is the OAuth playground . Maven users will need to add the following dependency to their pom.xml for this component: 126.1. URI Format The Google Sheets Component uses the following URI format: 126.2. GoogleSheetsStreamComponent The Google Sheets Stream component supports 3 options, which are listed below. Name Description Default Type configuration (consumer) To use the shared configuration GoogleSheetsStream Configuration clientFactory (advanced) To use the GoogleSheetsClientFactory as factory for creating the client. Will by default use BatchGoogleSheetsClientFactory GoogleSheetsClient Factory resolveProperty Placeholders (advanced) Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. true boolean The Google Sheets Stream endpoint is configured using URI syntax: with the following path and query parameters: 126.2.1. Path Parameters (1 parameters): Name Description Default Type apiName Sets the apiName. String 126.2.2. Query Parameters (31 parameters): Name Description Default Type accessToken (consumer) OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. String applicationName (consumer) Google sheets application name. Example would be camel-google-sheets/1.0 String bridgeErrorHandler (consumer) 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 message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. false boolean clientId (consumer) Client ID of the sheets application String clientSecret (consumer) Client secret of the sheets application String includeGridData (consumer) True if grid data should be returned. false boolean majorDimension (consumer) Specifies the major dimension that results should use.. ROWS String maxResults (consumer) Specify the maximum number of returned results. This will limit the number of rows in a returned value range data set or the number of returned value ranges in a batch request. 10 int range (consumer) Specifies the range of rows and columns in a sheet to get data from. String refreshToken (consumer) OAuth 2 refresh token. 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 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 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. 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. ExchangePattern pollStrategy (consumer) A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. PollingConsumerPoll Strategy synchronous (advanced) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). false boolean backoffErrorThreshold (scheduler) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. int backoffIdleThreshold (scheduler) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. int backoffMultiplier (scheduler) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. int delay (scheduler) Milliseconds before the poll. You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour). 500 long greedy (scheduler) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the run polled 1 or more messages. false boolean initialDelay (scheduler) Milliseconds before the first poll starts. You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour). 1000 long runLoggingLevel (scheduler) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. TRACE LoggingLevel scheduledExecutorService (scheduler) Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. ScheduledExecutor Service scheduler (scheduler) To use a cron scheduler from either camel-spring or camel-quartz2 component none ScheduledPollConsumer Scheduler schedulerProperties (scheduler) To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler. Map startScheduler (scheduler) Whether the scheduler should be auto started. true boolean timeUnit (scheduler) Time unit for initialDelay and delay options. MILLISECONDS TimeUnit useFixedDelay (scheduler) Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. true boolean 126.3. Spring Boot Auto-Configuration The component supports 16 options, which are listed below. Name Description Default Type camel.component.google-sheets-stream.client-factory To use the GoogleSheetsClientFactory as factory for creating the client. Will by default use BatchGoogleSheetsClientFactory. The option is a org.apache.camel.component.google.sheets.GoogleSheetsClientFactory type. String camel.component.google-sheets-stream.configuration.access-token OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. String camel.component.google-sheets-stream.configuration.api-name Sets the apiName. String camel.component.google-sheets-stream.configuration.application-name Google sheets application name. Example would be camel-google-sheets/1.0 String camel.component.google-sheets-stream.configuration.client-id Client ID of the sheets application String camel.component.google-sheets-stream.configuration.client-secret Client secret of the sheets application String camel.component.google-sheets-stream.configuration.include-grid-data True if grid data should be returned. false Boolean camel.component.google-sheets-stream.configuration.major-dimension Specifies the major dimension that results should use.. ROWS String camel.component.google-sheets-stream.configuration.max-results Specify the maximum number of returned results. This will limit the number of rows in a returned value range data set or the number of returned value ranges in a batch request. 0 Integer camel.component.google-sheets-stream.configuration.range Specifies the range of rows and columns in a sheet to get data from. String camel.component.google-sheets-stream.configuration.refresh-token OAuth 2 refresh token. 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 camel.component.google-sheets-stream.configuration.scopes 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 camel.component.google-sheets-stream.configuration.spreadsheet-id Specifies the spreadsheet identifier that is used to identify the target to obtain. String camel.component.google-sheets-stream.configuration.value-render-option Determines how values should be rendered in the output. FORMATTED_VALUE String camel.component.google-sheets-stream.enabled Whether to enable auto configuration of the google-sheets-stream component. This is enabled by default. Boolean camel.component.google-sheets-stream.resolve-property-placeholders Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. true Boolean 126.4. Consumer The consumer will poll by default with maxResults equals to 5. For example from("google-sheets-stream://data?range=A:B&delay=5000&maxResults=5").to("mock:result"); This route will consume the ten events starting from the date of polling.
<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-google-sheets</artifactId> <version>2.23.0</version> </dependency> google-sheets-stream://apiName?[options] google-sheets-stream:apiName from("google-sheets-stream://data?range=A:B&delay=5000&maxResults=5").to("mock:result");