Interface GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointBuilder
- Enclosing interface:
- GoogleSheetsEndpointBuilderFactory
public static interface GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Google Sheets component.
-
Method Summary
Modifier and TypeMethodDescriptionaccessToken
(String accessToken) OAuth 2 access token.advanced()
applicationName
(String applicationName) Google Sheets application name.backoffErrorThreshold
(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffErrorThreshold
(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffMultiplier
(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.backoffMultiplier
(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.Client ID of the sheets application.clientSecret
(String clientSecret) Client secret of the sheets application.delay
(long delay) Milliseconds before the next poll.Milliseconds before the next poll.Delegate for wide-domain service account.greedy
(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.Sets the name of a parameter to be passed in the exchange In Body.initialDelay
(long initialDelay) Milliseconds before the first poll starts.initialDelay
(String initialDelay) Milliseconds before the first poll starts.refreshToken
(String refreshToken) OAuth 2 refresh token.repeatCount
(long repeatCount) Specifies a maximum limit of number of fires.repeatCount
(String repeatCount) Specifies a maximum limit of number of fires.runLoggingLevel
(String runLoggingLevel) The consumer logs a start/complete log line when it polls.runLoggingLevel
(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.scheduledExecutorService
(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.scheduledExecutorService
(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.To use a cron scheduler from either camel-spring or camel-quartz component.To use a cron scheduler from either camel-spring or camel-quartz component.schedulerProperties
(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.schedulerProperties
(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.Specifies the level of permissions you want a sheets application to have to a user account.scopes
(Collection<String> scopes) Specifies the level of permissions you want a sheets application to have to a user account.sendEmptyMessageWhenIdle
(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.sendEmptyMessageWhenIdle
(String sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.serviceAccountKey
(String serviceAccountKey) Sets .json file with credentials for Service account.splitResult
(boolean splitResult) When consumer return an array or collection this will generate one exchange per element, and their routes will be executed once for each exchange.splitResult
(String splitResult) When consumer return an array or collection this will generate one exchange per element, and their routes will be executed once for each exchange.startScheduler
(boolean startScheduler) Whether the scheduler should be auto started.startScheduler
(String startScheduler) Whether the scheduler should be auto started.Time unit for initialDelay and delay options.Time unit for initialDelay and delay options.useFixedDelay
(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.useFixedDelay
(String useFixedDelay) Controls if fixed delay or fixed rate is used.Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
-
Method Details
-
advanced
-
applicationName
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder applicationName(String applicationName) Google Sheets application name. Example would be camel-google-sheets/1.0. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
applicationName
- the value to set- Returns:
- the dsl builder
-
clientId
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder clientId(String clientId) Client ID of the sheets application. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
clientId
- the value to set- Returns:
- the dsl builder
-
delegate
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder delegate(String delegate) Delegate for wide-domain service account. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
delegate
- the value to set- Returns:
- the dsl builder
-
inBody
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder inBody(String inBody) Sets the name of a parameter to be passed in the exchange In Body. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
inBody
- the value to set- Returns:
- the dsl builder
-
scopes
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder scopes(Collection<String> 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. The option is a: <code>java.util.Collection<java.lang.String></code> type. Group: common- Parameters:
scopes
- the value to set- Returns:
- the dsl builder
-
scopes
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder scopes(String 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. The option will be converted to a <code>java.util.Collection<java.lang.String></code> type. Group: common- Parameters:
scopes
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
splitResult
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder splitResult(boolean splitResult) 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. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
splitResult
- the value to set- Returns:
- the dsl builder
-
splitResult
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder splitResult(String splitResult) 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. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer- Parameters:
splitResult
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder backoffMultiplier(int 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. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder backoffMultiplier(String 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. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
delay
Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
delay
Milliseconds before the next poll. The option will be converted to a <code>long</code> type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
greedy
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder greedy(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
greedy
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder greedy(String greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
initialDelay
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder initialDelay(long initialDelay) Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
initialDelay
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder initialDelay(String initialDelay) Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
repeatCount
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder repeatCount(long 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. The option is a: <code>long</code> type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
repeatCount
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder repeatCount(String 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. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService 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. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder scheduledExecutorService(String 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. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduler
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder scheduler(Object scheduler) To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
scheduler
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder scheduler(String scheduler) To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
schedulerProperties
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder schedulerProperties(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
key
- the option keyvalue
- the option value- Returns:
- the dsl builder
-
schedulerProperties
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder schedulerProperties(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
values
- the values- Returns:
- the dsl builder
-
startScheduler
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder startScheduler(boolean startScheduler) Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
startScheduler
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder startScheduler(String startScheduler) Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
timeUnit
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder timeUnit(TimeUnit timeUnit) Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
timeUnit
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder timeUnit(String timeUnit) Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay) Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder useFixedDelay(String useFixedDelay) Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
accessToken
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder accessToken(String accessToken) OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
accessToken
- the value to set- Returns:
- the dsl builder
-
clientSecret
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder clientSecret(String clientSecret) Client secret of the sheets application. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
clientSecret
- the value to set- Returns:
- the dsl builder
-
refreshToken
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder refreshToken(String refreshToken) 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. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
refreshToken
- the value to set- Returns:
- the dsl builder
-
serviceAccountKey
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder serviceAccountKey(String serviceAccountKey) Sets .json file with credentials for Service account. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
serviceAccountKey
- the value to set- Returns:
- the dsl builder
-