MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder (Camel

All Superinterfaces:

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

All Known Subinterfaces:

MyBatisEndpointBuilderFactory.MyBatisEndpointBuilder

Enclosing interface:

MyBatisEndpointBuilderFactory
```
public static interface MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the MyBatis component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default MyBatisEndpointBuilderFactory.AdvancedMyBatisEndpointConsumerBuilder`	`advanced()`
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`backoffErrorThreshold(int backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`backoffErrorThreshold(String backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`backoffIdleThreshold(int backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`backoffIdleThreshold(String backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`backoffMultiplier(int backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`backoffMultiplier(String backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`delay(long delay)` Milliseconds before the next poll.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`delay(String delay)` Milliseconds before the next poll.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`greedy(boolean greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`greedy(String greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`initialDelay(long initialDelay)` Milliseconds before the first poll starts.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`initialDelay(String initialDelay)` Milliseconds before the first poll starts.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`maxMessagesPerPoll(int maxMessagesPerPoll)` This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`maxMessagesPerPoll(String maxMessagesPerPoll)` This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`onConsume(String onConsume)` Statement to run after data has been processed in the route.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`repeatCount(long repeatCount)` Specifies a maximum limit of number of fires.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`repeatCount(String repeatCount)` Specifies a maximum limit of number of fires.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`routeEmptyResultSet(boolean routeEmptyResultSet)` Whether allow empty resultset to be routed to the next hop.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`routeEmptyResultSet(String routeEmptyResultSet)` Whether allow empty resultset to be routed to the next hop.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`runLoggingLevel(String runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`scheduledExecutorService(String scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`scheduler(Object scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`scheduler(String scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`schedulerProperties(Map values)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`schedulerProperties(String key, Object value)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`startScheduler(boolean startScheduler)` Whether the scheduler should be auto started.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`startScheduler(String startScheduler)` Whether the scheduler should be auto started.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`timeUnit(String timeUnit)` Time unit for initialDelay and delay options.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`timeUnit(TimeUnit timeUnit)` Time unit for initialDelay and delay options.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`transacted(boolean transacted)` Enables or disables transaction.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`transacted(String transacted)` Enables or disables transaction.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`useFixedDelay(boolean useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`useFixedDelay(String useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`useIterator(boolean useIterator)` Process resultset individually or as a list.
`default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder`	`useIterator(String useIterator)` Process resultset individually or as a list.

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 MyBatisEndpointBuilderFactory.AdvancedMyBatisEndpointConsumerBuilder advanced()
```
  - bridgeErrorHandler
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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
  - maxMessagesPerPoll
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder maxMessagesPerPoll(int maxMessagesPerPoll)
```
    This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges. This integer defines the maximum messages to deliver in single exchange. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disable it. The option is a: int type. Default: 0 Group: consumer
  - maxMessagesPerPoll
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder maxMessagesPerPoll(String maxMessagesPerPoll)
```
    This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges. This integer defines the maximum messages to deliver in single exchange. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disable it. The option will be converted to a int type. Default: 0 Group: consumer
  - onConsume
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder onConsume(String onConsume)
```
    Statement to run after data has been processed in the route. The option is a: java.lang.String type. Group: consumer
  - routeEmptyResultSet
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder routeEmptyResultSet(boolean routeEmptyResultSet)
```
    Whether allow empty resultset to be routed to the next hop. The option is a: boolean type. Default: false Group: consumer
  - routeEmptyResultSet
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder routeEmptyResultSet(String routeEmptyResultSet)
```
    Whether allow empty resultset to be routed to the next hop. The option will be converted to a boolean type. Default: false Group: consumer
  - sendEmptyMessageWhenIdle
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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
  - transacted
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder transacted(boolean transacted)
```
    Enables or disables transaction. If enabled then if processing an exchange failed then the consumer breaks out processing any further exchanges to cause a rollback eager. The option is a: boolean type. Default: false Group: consumer
  - transacted
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder transacted(String transacted)
```
    Enables or disables transaction. If enabled then if processing an exchange failed then the consumer breaks out processing any further exchanges to cause a rollback eager. The option will be converted to a boolean type. Default: false Group: consumer
  - useIterator
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder useIterator(boolean useIterator)
```
    Process resultset individually or as a list. The option is a: boolean type. Default: true Group: consumer
  - useIterator
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder useIterator(String useIterator)
```
    Process resultset individually or as a list. The option will be converted to a boolean type. Default: true Group: consumer
  - backoffErrorThreshold
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder delay(long delay)
```
    Milliseconds before the next poll. The option is a: long type. Default: 500 Group: scheduler
  - delay
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder delay(String delay)
```
    Milliseconds before the next poll. The option will be converted to a long type. Default: 500 Group: scheduler
  - greedy
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder initialDelay(long initialDelay)
```
    Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler
  - initialDelay
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder initialDelay(String initialDelay)
```
    Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler
  - repeatCount
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder startScheduler(boolean startScheduler)
```
    Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler
  - startScheduler
```
default MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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 MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder 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

Interface MyBatisEndpointBuilderFactory.MyBatisEndpointConsumerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

bridgeErrorHandler

bridgeErrorHandler

maxMessagesPerPoll

maxMessagesPerPoll

onConsume

routeEmptyResultSet

routeEmptyResultSet

sendEmptyMessageWhenIdle

sendEmptyMessageWhenIdle

transacted

transacted

useIterator

useIterator

backoffErrorThreshold

backoffErrorThreshold

backoffIdleThreshold

backoffIdleThreshold

backoffMultiplier

backoffMultiplier

delay

delay

greedy

greedy

initialDelay

initialDelay

repeatCount

repeatCount

runLoggingLevel

runLoggingLevel

scheduledExecutorService

scheduledExecutorService

scheduler

scheduler

schedulerProperties

schedulerProperties

startScheduler

startScheduler

timeUnit

timeUnit

useFixedDelay

useFixedDelay