org.apache.camel.builder.endpoint.dsl

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 Type	Method and Description
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	accessToken(String accessToken) OAuth 2 access token.
default GoogleSheetsEndpointBuilderFactory.AdvancedGoogleSheetsEndpointConsumerBuilder	advanced()
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	applicationName(String applicationName) Google Sheets application name.
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.
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.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	backoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	backoffIdleThreshold(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
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.
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.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	bridgeErrorHandler(boolean 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.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	bridgeErrorHandler(String 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.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	clientId(String clientId) Client ID of the sheets application.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	clientSecret(String clientSecret) Client secret of the sheets application.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	delay(long delay) Milliseconds before the next poll.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	delay(String delay) Milliseconds before the next poll.
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.
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.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	inBody(String inBody) Sets the name of a parameter to be passed in the exchange In Body.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	initialDelay(long initialDelay) Milliseconds before the first poll starts.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	initialDelay(String initialDelay) Milliseconds before the first poll starts.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	refreshToken(String refreshToken) OAuth 2 refresh token.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	repeatCount(long repeatCount) Specifies a maximum limit of number of fires.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	repeatCount(String repeatCount) Specifies a maximum limit of number of fires.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	scheduledExecutorService(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	scheduler(Object scheduler) To use a cron scheduler from either camel-spring or camel-quartz component.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	scheduler(String scheduler) To use a cron scheduler from either camel-spring or camel-quartz component.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	schedulerProperties(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
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.
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.
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.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	startScheduler(boolean startScheduler) Whether the scheduler should be auto started.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	startScheduler(String startScheduler) Whether the scheduler should be auto started.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	timeUnit(String timeUnit) Time unit for initialDelay and delay options.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	timeUnit(TimeUnit timeUnit) Time unit for initialDelay and delay options.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	useFixedDelay(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder	useFixedDelay(String useFixedDelay) Controls if fixed delay or fixed rate is used.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default GoogleSheetsEndpointBuilderFactory.AdvancedGoogleSheetsEndpointConsumerBuilder advanced()

applicationName

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder applicationName(String applicationName)

Google Sheets application name. Example would be camel-google-sheets/1.0. The option is a: java.lang.String type. Group: common

clientId

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder clientId(String clientId)

Client ID of the sheets application. The option is a: java.lang.String type. Group: common

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: java.lang.String type. Group: common

bridgeErrorHandler

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder bridgeErrorHandler(boolean 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. The option is a: boolean type. Default: false Group: consumer

bridgeErrorHandler

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder bridgeErrorHandler(String 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. The option will be converted to a boolean type. Default: false Group: consumer

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: boolean type. Default: false Group: consumer

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 boolean type. Default: false Group: consumer

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: int type. Group: scheduler

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 int type. Group: scheduler

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: int type. Group: scheduler

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 int type. Group: scheduler

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: int type. Group: scheduler

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 int type. Group: scheduler

delay

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder delay(long delay)

Milliseconds before the next poll. The option is a: long type. Default: 500 Group: scheduler

delay

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder delay(String delay)

Milliseconds before the next poll. The option will be converted to a long type. Default: 500 Group: scheduler

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: boolean type. Default: false Group: scheduler

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 boolean type. Default: false Group: scheduler

initialDelay

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder initialDelay(long initialDelay)

Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler

initialDelay

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder initialDelay(String initialDelay)

Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler

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: long type. Default: 0 Group: scheduler

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 long type. Default: 0 Group: scheduler

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: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler

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 org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler

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: java.util.concurrent.ScheduledExecutorService type. Group: scheduler

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 java.util.concurrent.ScheduledExecutorService type. Group: scheduler

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: java.lang.Object type. Default: none Group: scheduler

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 java.lang.Object type. Default: none Group: scheduler

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: java.util.Map<java.lang.String, java.lang.Object> 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

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: java.util.Map<java.lang.String, java.lang.Object> 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

startScheduler

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder startScheduler(boolean startScheduler)

Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler

startScheduler

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder startScheduler(String startScheduler)

Whether the scheduler should be auto started. The option will be converted to a boolean type. Default: true Group: scheduler

timeUnit

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)

Time unit for initialDelay and delay options. The option is a: java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler

timeUnit

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder timeUnit(String timeUnit)

Time unit for initialDelay and delay options. The option will be converted to a java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler

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: boolean type. Default: true Group: scheduler

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 boolean type. Default: true Group: scheduler

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: java.lang.String type. Group: security

clientSecret

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointConsumerBuilder clientSecret(String clientSecret)

Client secret of the sheets application. The option is a: java.lang.String type. Group: security

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: java.lang.String type. Group: security