Google Sheets

Manage spreadsheets in Google Sheets.

What’s inside

Google Sheets component, URI syntax: google-sheets:apiName/methodName
Google Sheets Stream component, URI syntax: google-sheets-stream:spreadsheetId

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-google-sheets-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 36 options, which are listed below.

Name	Description	Default	Type
camel.component.google-sheets-stream.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.application-name	Google Sheets application name. Example would be camel-google-sheets/1.0		String
camel.component.google-sheets-stream.autowired-enabled	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
camel.component.google-sheets-stream.bridge-error-handler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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
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.		GoogleSheetsClientFactory
camel.component.google-sheets-stream.client-id	Client ID of the sheets application		String
camel.component.google-sheets-stream.client-secret	Client secret of the sheets application		String
camel.component.google-sheets-stream.configuration	To use the shared configuration. The option is a org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration type.		GoogleSheetsStreamConfiguration
camel.component.google-sheets-stream.delegate	Delegate for wide-domain service account		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.health-check-consumer-enabled	Used for enabling or disabling all consumer based health checks from this component	true	Boolean
camel.component.google-sheets-stream.health-check-producer-enabled	Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.	true	Boolean
camel.component.google-sheets-stream.include-grid-data	True if grid data should be returned.	false	Boolean
camel.component.google-sheets-stream.major-dimension	Specifies the major dimension that results should use..	ROWS	String
camel.component.google-sheets-stream.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.		Integer
camel.component.google-sheets-stream.range	Specifies the range of rows and columns in a sheet to get data from.		String
camel.component.google-sheets-stream.refresh-token	OAuth 2 refresh token. Using this, the Google Sheets 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.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. Multiple scopes can be separated by comma.		String
camel.component.google-sheets-stream.service-account-key	Sets .json file with credentials for Service account		String
camel.component.google-sheets-stream.split-results	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
camel.component.google-sheets-stream.value-render-option	Determines how values should be rendered in the output.	FORMATTED_VALUE	String
camel.component.google-sheets.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.application-name	Google Sheets application name. Example would be camel-google-sheets/1.0		String
camel.component.google-sheets.autowired-enabled	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
camel.component.google-sheets.bridge-error-handler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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
camel.component.google-sheets.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.		GoogleSheetsClientFactory
camel.component.google-sheets.client-id	Client ID of the sheets application		String
camel.component.google-sheets.client-secret	Client secret of the sheets application		String
camel.component.google-sheets.configuration	To use the shared configuration. The option is a org.apache.camel.component.google.sheets.GoogleSheetsConfiguration type.		GoogleSheetsConfiguration
camel.component.google-sheets.delegate	Delegate for wide-domain service account		String
camel.component.google-sheets.enabled	Whether to enable auto configuration of the google-sheets component. This is enabled by default.		Boolean
camel.component.google-sheets.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.google-sheets.refresh-token	OAuth 2 refresh token. Using this, the Google Sheets component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived.		String
camel.component.google-sheets.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. Multiple scopes can be separated by comma.		String
camel.component.google-sheets.service-account-key	Sets .json file with credentials for Service account		String
camel.component.google-sheets.split-result	When consumer return an array or collection this will generate one exchange per element, and their routes will be executed once for each exchange. Set this value to false to use a single exchange for the entire list or array.	true	Boolean

Name

Description

Default

Type

camel.component.google-sheets-stream.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.application-name

Google Sheets application name. Example would be camel-google-sheets/1.0

String

camel.component.google-sheets-stream.autowired-enabled

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

camel.component.google-sheets-stream.bridge-error-handler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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

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.

GoogleSheetsClientFactory

camel.component.google-sheets-stream.client-id

Client ID of the sheets application

String

camel.component.google-sheets-stream.client-secret

Client secret of the sheets application

String

camel.component.google-sheets-stream.configuration

To use the shared configuration. The option is a org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration type.

GoogleSheetsStreamConfiguration

camel.component.google-sheets-stream.delegate

Delegate for wide-domain service account

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.health-check-consumer-enabled

Used for enabling or disabling all consumer based health checks from this component

true

Boolean

camel.component.google-sheets-stream.health-check-producer-enabled

Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true.

true

Boolean

camel.component.google-sheets-stream.include-grid-data

True if grid data should be returned.

false

Boolean

camel.component.google-sheets-stream.major-dimension

Specifies the major dimension that results should use..

ROWS

String

camel.component.google-sheets-stream.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.

Integer

camel.component.google-sheets-stream.range

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

String

camel.component.google-sheets-stream.refresh-token

OAuth 2 refresh token. Using this, the Google Sheets 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.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. Multiple scopes can be separated by comma.

String

camel.component.google-sheets-stream.service-account-key

Sets .json file with credentials for Service account

String

camel.component.google-sheets-stream.split-results

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

camel.component.google-sheets-stream.value-render-option

Determines how values should be rendered in the output.

FORMATTED_VALUE

String

camel.component.google-sheets.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.application-name

Google Sheets application name. Example would be camel-google-sheets/1.0

String

camel.component.google-sheets.autowired-enabled

true

Boolean

camel.component.google-sheets.bridge-error-handler

false

Boolean

camel.component.google-sheets.client-factory

GoogleSheetsClientFactory

camel.component.google-sheets.client-id

Client ID of the sheets application

String

camel.component.google-sheets.client-secret

Client secret of the sheets application

String

camel.component.google-sheets.configuration

To use the shared configuration. The option is a org.apache.camel.component.google.sheets.GoogleSheetsConfiguration type.

GoogleSheetsConfiguration

camel.component.google-sheets.delegate

Delegate for wide-domain service account

String

camel.component.google-sheets.enabled

Whether to enable auto configuration of the google-sheets component. This is enabled by default.

Boolean

camel.component.google-sheets.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.google-sheets.refresh-token

OAuth 2 refresh token. Using this, the Google Sheets component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived.

String

camel.component.google-sheets.scopes

String

camel.component.google-sheets.service-account-key

Sets .json file with credentials for Service account

String

camel.component.google-sheets.split-result

When consumer return an array or collection this will generate one exchange per element, and their routes will be executed once for each exchange. Set this value to false to use a single exchange for the entire list or array.

true

Boolean