org.apache.camel.builder.endpoint.dsl

Interface GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointBuilder

Enclosing interface:

GoogleDriveEndpointBuilderFactory

public static interface GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the Google Drive component.

Method Summary

Modifier and Type	Method and Description
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	accessToken(String accessToken) OAuth 2 access token.
default GoogleDriveEndpointBuilderFactory.AdvancedGoogleDriveEndpointConsumerBuilder	advanced()
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	applicationName(String applicationName) Google drive application name.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	backoffErrorThreshold(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	backoffErrorThreshold(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	backoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	backoffIdleThreshold(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	backoffMultiplier(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	backoffMultiplier(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	clientFactory(Object clientFactory) To use the GoogleCalendarClientFactory as factory for creating the client.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	clientFactory(String clientFactory) To use the GoogleCalendarClientFactory as factory for creating the client.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	clientId(String clientId) Client ID of the drive application.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	clientSecret(String clientSecret) Client secret of the drive application.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	delay(long delay) Milliseconds before the next poll.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	delay(String delay) Milliseconds before the next poll.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	greedy(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	greedy(String greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	inBody(String inBody) Sets the name of a parameter to be passed in the exchange In Body.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	initialDelay(long initialDelay) Milliseconds before the first poll starts.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	initialDelay(String initialDelay) Milliseconds before the first poll starts.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	refreshToken(String refreshToken) OAuth 2 refresh token.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	repeatCount(long repeatCount) Specifies a maximum limit of number of fires.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	repeatCount(String repeatCount) Specifies a maximum limit of number of fires.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	scheduledExecutorService(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	scheduler(Object scheduler) To use a cron scheduler from either camel-spring or camel-quartz component.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	scheduler(String scheduler) To use a cron scheduler from either camel-spring or camel-quartz component.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	schedulerProperties(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	schedulerProperties(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	scopes(List<String> scopes) Specifies the level of permissions you want a drive application to have to a user account.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	scopes(String scopes) Specifies the level of permissions you want a drive application to have to a user account.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	startScheduler(boolean startScheduler) Whether the scheduler should be auto started.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	startScheduler(String startScheduler) Whether the scheduler should be auto started.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	timeUnit(String timeUnit) Time unit for initialDelay and delay options.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	timeUnit(TimeUnit timeUnit) Time unit for initialDelay and delay options.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	useFixedDelay(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.
default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder	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 GoogleDriveEndpointBuilderFactory.AdvancedGoogleDriveEndpointConsumerBuilder advanced()

applicationName

default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder applicationName(String applicationName)

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

clientFactory

default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder clientFactory(Object clientFactory)

To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory. The option is a: org.apache.camel.component.google.drive.GoogleDriveClientFactory type. Group: common

clientFactory

default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder clientFactory(String clientFactory)

To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory. The option will be converted to a org.apache.camel.component.google.drive.GoogleDriveClientFactory type. Group: common

clientId

default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder clientId(String clientId)

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

inBody

default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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

scopes

default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder scopes(List<String> scopes)

Specifies the level of permissions you want a drive application to have to a user account. See https://developers.google.com/drive/web/scopes for more info. The option is a: java.util.List<java.lang.String> type. Group: common

scopes

default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder scopes(String scopes)

Specifies the level of permissions you want a drive application to have to a user account. See https://developers.google.com/drive/web/scopes for more info. The option will be converted to a java.util.List<java.lang.String> type. Group: common

bridgeErrorHandler

default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder delay(long delay)

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

delay

default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder delay(String delay)

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

greedy

default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder initialDelay(long initialDelay)

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

initialDelay

default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder initialDelay(String initialDelay)

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

repeatCount

default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder startScheduler(boolean startScheduler)

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

startScheduler

default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder 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 GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder clientSecret(String clientSecret)

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

refreshToken

default GoogleDriveEndpointBuilderFactory.GoogleDriveEndpointConsumerBuilder refreshToken(String 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. The option is a: java.lang.String type. Group: security