camel-google-sheets-stream-kafka-connector source configuration

When using camel-google-sheets-stream-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-google-sheets-stream-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.googlesheetsstream.CamelGooglesheetsstreamSourceConnector

The camel-google-sheets-stream source connector supports 51 options, which are listed below.

Name	Description	Default	Required	Priority
camel.source.path.apiName	Sets the apiName.	null	true	HIGH
camel.source.endpoint.applicationName	Google sheets application name. Example would be camel-google-sheets/1.0	null	false	MEDIUM
camel.source.endpoint.bridgeErrorHandler	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	false	MEDIUM
camel.source.endpoint.clientId	Client ID of the sheets application	null	false	MEDIUM
camel.source.endpoint.includeGridData	True if grid data should be returned.	false	false	MEDIUM
camel.source.endpoint.majorDimension	Specifies the major dimension that results should use.. One of: [ROWS] [COLUMNS] [DIMENSION_UNSPECIFIED]	"ROWS"	false	MEDIUM
camel.source.endpoint.maxResults	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.	null	false	MEDIUM
camel.source.endpoint.range	Specifies the range of rows and columns in a sheet to get data from.	null	false	MEDIUM
camel.source.endpoint.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.	null	false	MEDIUM
camel.source.endpoint.sendEmptyMessageWhenIdle	If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.	false	false	MEDIUM
camel.source.endpoint.splitResults	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	false	MEDIUM
camel.source.endpoint.spreadsheetId	Specifies the spreadsheet identifier that is used to identify the target to obtain.	null	false	MEDIUM
camel.source.endpoint.valueRenderOption	Determines how values should be rendered in the output. One of: [FORMATTED_VALUE] [UNFORMATTED_VALUE] [FORMULA]	"FORMATTED_VALUE"	false	MEDIUM
camel.source.endpoint.exceptionHandler	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.	null	false	MEDIUM
camel.source.endpoint.exchangePattern	Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]	null	false	MEDIUM
camel.source.endpoint.pollStrategy	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.	null	false	MEDIUM
camel.source.endpoint.synchronous	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	false	MEDIUM
camel.source.endpoint.backoffErrorThreshold	The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.	null	false	MEDIUM
camel.source.endpoint.backoffIdleThreshold	The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.	null	false	MEDIUM
camel.source.endpoint.backoffMultiplier	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 next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.	null	false	MEDIUM
camel.source.endpoint.delay	Milliseconds before the next poll.	500L	false	MEDIUM
camel.source.endpoint.greedy	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.	false	false	MEDIUM
camel.source.endpoint.initialDelay	Milliseconds before the first poll starts.	1000L	false	MEDIUM
camel.source.endpoint.repeatCount	Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.	0L	false	MEDIUM
camel.source.endpoint.runLoggingLevel	The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF]	"TRACE"	false	MEDIUM
camel.source.endpoint.scheduledExecutorService	Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.	null	false	MEDIUM
camel.source.endpoint.scheduler	To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler	"none"	false	MEDIUM
camel.source.endpoint.schedulerProperties	To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.	null	false	MEDIUM
camel.source.endpoint.startScheduler	Whether the scheduler should be auto started.	true	false	MEDIUM
camel.source.endpoint.timeUnit	Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS]	"MILLISECONDS"	false	MEDIUM
camel.source.endpoint.useFixedDelay	Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.	true	false	MEDIUM
camel.source.endpoint.accessToken	OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.	null	false	MEDIUM
camel.source.endpoint.clientSecret	Client secret of the sheets application	null	false	MEDIUM
camel.source.endpoint.refreshToken	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.	null	false	MEDIUM
camel.component.google-sheets-stream.application Name	Google sheets application name. Example would be camel-google-sheets/1.0	null	false	MEDIUM
camel.component.google-sheets-stream.bridgeError Handler	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	false	MEDIUM
camel.component.google-sheets-stream.clientId	Client ID of the sheets application	null	false	MEDIUM
camel.component.google-sheets-stream.configuration	To use the shared configuration	null	false	MEDIUM
camel.component.google-sheets-stream.includeGrid Data	True if grid data should be returned.	false	false	MEDIUM
camel.component.google-sheets-stream.major Dimension	Specifies the major dimension that results should use.. One of: [ROWS] [COLUMNS] [DIMENSION_UNSPECIFIED]	"ROWS"	false	MEDIUM
camel.component.google-sheets-stream.maxResults	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.	null	false	MEDIUM
camel.component.google-sheets-stream.range	Specifies the range of rows and columns in a sheet to get data from.	null	false	MEDIUM
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.	null	false	MEDIUM
camel.component.google-sheets-stream.splitResults	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	false	MEDIUM
camel.component.google-sheets-stream.spreadsheetId	Specifies the spreadsheet identifier that is used to identify the target to obtain.	null	false	MEDIUM
camel.component.google-sheets-stream.valueRender Option	Determines how values should be rendered in the output. One of: [FORMATTED_VALUE] [UNFORMATTED_VALUE] [FORMULA]	"FORMATTED_VALUE"	false	MEDIUM
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	false	MEDIUM
camel.component.google-sheets-stream.clientFactory	To use the GoogleSheetsClientFactory as factory for creating the client. Will by default use BatchGoogleSheetsClientFactory	null	false	MEDIUM
camel.component.google-sheets-stream.accessToken	OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.	null	false	MEDIUM
camel.component.google-sheets-stream.clientSecret	Client secret of the sheets application	null	false	MEDIUM
camel.component.google-sheets-stream.refreshToken	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.	null	false	MEDIUM

Name

Description

Default

Required

Priority

camel.source.path.apiName

Sets the apiName.

null

true

HIGH

camel.source.endpoint.applicationName

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

null

false

MEDIUM

camel.source.endpoint.bridgeErrorHandler

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

MEDIUM

camel.source.endpoint.clientId

Client ID of the sheets application

null

false

MEDIUM

camel.source.endpoint.includeGridData

True if grid data should be returned.

false

MEDIUM

camel.source.endpoint.majorDimension

Specifies the major dimension that results should use.. One of: [ROWS] [COLUMNS] [DIMENSION_UNSPECIFIED]

"ROWS"

false

MEDIUM

camel.source.endpoint.maxResults

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.

null

false

MEDIUM

camel.source.endpoint.range

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

null

false

MEDIUM

camel.source.endpoint.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.

null

false

MEDIUM

camel.source.endpoint.sendEmptyMessageWhenIdle

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.

false

MEDIUM

camel.source.endpoint.splitResults

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

MEDIUM

camel.source.endpoint.spreadsheetId

Specifies the spreadsheet identifier that is used to identify the target to obtain.

null

false

MEDIUM

camel.source.endpoint.valueRenderOption

Determines how values should be rendered in the output. One of: [FORMATTED_VALUE] [UNFORMATTED_VALUE] [FORMULA]

"FORMATTED_VALUE"

false

MEDIUM

camel.source.endpoint.exceptionHandler

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.

null

false

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]

null

false

MEDIUM

camel.source.endpoint.pollStrategy

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.

null

false

MEDIUM

camel.source.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.source.endpoint.backoffErrorThreshold

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.

null

false

MEDIUM

camel.source.endpoint.backoffIdleThreshold

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.

null

false

MEDIUM

camel.source.endpoint.backoffMultiplier

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 next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.

null

false

MEDIUM

camel.source.endpoint.delay

Milliseconds before the next poll.

500L

false

MEDIUM

camel.source.endpoint.greedy

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

false

MEDIUM

camel.source.endpoint.initialDelay

Milliseconds before the first poll starts.

1000L

false

MEDIUM

camel.source.endpoint.repeatCount

Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.

false

MEDIUM

camel.source.endpoint.runLoggingLevel

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF]

"TRACE"

false

MEDIUM

camel.source.endpoint.scheduledExecutorService

Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.

null

false

MEDIUM

camel.source.endpoint.scheduler

To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler

"none"

false

MEDIUM

camel.source.endpoint.schedulerProperties

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.

null

false

MEDIUM

camel.source.endpoint.startScheduler

Whether the scheduler should be auto started.

true

false

MEDIUM

camel.source.endpoint.timeUnit

Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS]

"MILLISECONDS"

false

MEDIUM

camel.source.endpoint.useFixedDelay

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

true

false

MEDIUM

camel.source.endpoint.accessToken

OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.

null

false

MEDIUM

camel.source.endpoint.clientSecret

Client secret of the sheets application

null

false

MEDIUM

camel.source.endpoint.refreshToken

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.

null

false

MEDIUM

camel.component.google-sheets-stream.application Name

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

null

false

MEDIUM

camel.component.google-sheets-stream.bridgeError Handler

false

MEDIUM

camel.component.google-sheets-stream.clientId

Client ID of the sheets application

null

false

MEDIUM

camel.component.google-sheets-stream.configuration

To use the shared configuration

null

false

MEDIUM

camel.component.google-sheets-stream.includeGrid Data

True if grid data should be returned.

false

MEDIUM

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

Specifies the major dimension that results should use.. One of: [ROWS] [COLUMNS] [DIMENSION_UNSPECIFIED]

"ROWS"

false

MEDIUM

camel.component.google-sheets-stream.maxResults

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.

null

false

MEDIUM

camel.component.google-sheets-stream.range

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

null

false

MEDIUM

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.

null

false

MEDIUM

camel.component.google-sheets-stream.splitResults

false

MEDIUM

camel.component.google-sheets-stream.spreadsheetId

Specifies the spreadsheet identifier that is used to identify the target to obtain.

null

false

MEDIUM

camel.component.google-sheets-stream.valueRender Option

Determines how values should be rendered in the output. One of: [FORMATTED_VALUE] [UNFORMATTED_VALUE] [FORMULA]

"FORMATTED_VALUE"

false

MEDIUM

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

false

MEDIUM

camel.component.google-sheets-stream.clientFactory

To use the GoogleSheetsClientFactory as factory for creating the client. Will by default use BatchGoogleSheetsClientFactory

null

false

MEDIUM

camel.component.google-sheets-stream.accessToken

OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.

null

false

MEDIUM

camel.component.google-sheets-stream.clientSecret

Client secret of the sheets application

null

false

MEDIUM

camel.component.google-sheets-stream.refreshToken

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.

null

false

MEDIUM

The camel-google-sheets-stream source connector has no converters out of the box.

The camel-google-sheets-stream source connector has no transforms out of the box.

The camel-google-sheets-stream source connector has no aggregation strategies out of the box.