Package org.apache.camel.builder.endpoint.dsl

Interface BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

BeanstalkEndpointBuilderFactory.BeanstalkEndpointBuilder

Enclosing interface:

BeanstalkEndpointBuilderFactory

public static interface BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the Beanstalk component.

Method Summary

Modifier and Type	Method	Description
default BeanstalkEndpointBuilderFactory.AdvancedBeanstalkEndpointConsumerBuilder	advanced()
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	awaitJob(boolean awaitJob)	Whether to wait for job to complete before ack the job from beanstalk.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	awaitJob(String awaitJob)	Whether to wait for job to complete before ack the job from beanstalk.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	backoffErrorThreshold(int backoffErrorThreshold)	The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	backoffErrorThreshold(String backoffErrorThreshold)	The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	backoffIdleThreshold(int backoffIdleThreshold)	The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	backoffIdleThreshold(String backoffIdleThreshold)	The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	backoffMultiplier(int backoffMultiplier)	To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	backoffMultiplier(String backoffMultiplier)	To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	command(String command)	put means to put the job into Beanstalk.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	command(BeanstalkEndpointBuilderFactory.BeanstalkCommand command)	put means to put the job into Beanstalk.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	delay(long delay)	Milliseconds before the next poll.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	delay(String delay)	Milliseconds before the next poll.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	greedy(boolean greedy)	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	greedy(String greedy)	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	initialDelay(long initialDelay)	Milliseconds before the first poll starts.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	initialDelay(String initialDelay)	Milliseconds before the first poll starts.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	jobDelay(int jobDelay)	Job delay in seconds.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	jobDelay(String jobDelay)	Job delay in seconds.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	jobPriority(long jobPriority)	Job priority.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	jobPriority(String jobPriority)	Job priority.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	jobTimeToRun(int jobTimeToRun)	Job time to run in seconds.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	jobTimeToRun(String jobTimeToRun)	Job time to run in seconds.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	onFailure(String onFailure)	Command to use when processing failed.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	onFailure(BeanstalkEndpointBuilderFactory.BeanstalkCommand onFailure)	Command to use when processing failed.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	repeatCount(long repeatCount)	Specifies a maximum limit of number of fires.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	repeatCount(String repeatCount)	Specifies a maximum limit of number of fires.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	runLoggingLevel(String runLoggingLevel)	The consumer logs a start/complete log line when it polls.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)	The consumer logs a start/complete log line when it polls.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	scheduledExecutorService(String scheduledExecutorService)	Allows for configuring a custom/shared thread pool to use for the consumer.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)	Allows for configuring a custom/shared thread pool to use for the consumer.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	scheduler(String scheduler)	To use a cron scheduler from either camel-spring or camel-quartz component.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	schedulerProperties(String key, Object value)	To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	schedulerProperties(Map values)	To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	startScheduler(boolean startScheduler)	Whether the scheduler should be auto started.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	startScheduler(String startScheduler)	Whether the scheduler should be auto started.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	timeUnit(String timeUnit)	Time unit for initialDelay and delay options.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	timeUnit(TimeUnit timeUnit)	Time unit for initialDelay and delay options.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	useBlockIO(boolean useBlockIO)	Whether to use blockIO.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	useBlockIO(String useBlockIO)	Whether to use blockIO.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	useFixedDelay(boolean useFixedDelay)	Controls if fixed delay or fixed rate is used.
default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder	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 BeanstalkEndpointBuilderFactory.AdvancedBeanstalkEndpointConsumerBuilder advanced()

command

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder command(BeanstalkEndpointBuilderFactory.BeanstalkCommand command)

put means to put the job into Beanstalk. Job body is specified in the Camel message body. Job ID will be returned in beanstalk.jobId message header. delete, release, touch or bury expect Job ID in the message header beanstalk.jobId. Result of the operation is returned in beanstalk.result message header kick expects the number of jobs to kick in the message body and returns the number of jobs actually kicked out in the message header beanstalk.result. The option is a: org.apache.camel.component.beanstalk.BeanstalkCommand type. Group: common

command

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder command(String command)

put means to put the job into Beanstalk. Job body is specified in the Camel message body. Job ID will be returned in beanstalk.jobId message header. delete, release, touch or bury expect Job ID in the message header beanstalk.jobId. Result of the operation is returned in beanstalk.result message header kick expects the number of jobs to kick in the message body and returns the number of jobs actually kicked out in the message header beanstalk.result. The option will be converted to a org.apache.camel.component.beanstalk.BeanstalkCommand type. Group: common

jobDelay

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder jobDelay(int jobDelay)

Job delay in seconds. The option is a: int type. Default: 0 Group: common

jobDelay

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder jobDelay(String jobDelay)

Job delay in seconds. The option will be converted to a int type. Default: 0 Group: common

jobPriority

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder jobPriority(long jobPriority)

Job priority. (0 is the highest, see Beanstalk protocol). The option is a: long type. Default: 1000 Group: common

jobPriority

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder jobPriority(String jobPriority)

Job priority. (0 is the highest, see Beanstalk protocol). The option will be converted to a long type. Default: 1000 Group: common

jobTimeToRun

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder jobTimeToRun(int jobTimeToRun)

Job time to run in seconds. (when 0, the beanstalkd daemon raises it to 1 automatically, see Beanstalk protocol). The option is a: int type. Default: 60 Group: common

jobTimeToRun

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder jobTimeToRun(String jobTimeToRun)

Job time to run in seconds. (when 0, the beanstalkd daemon raises it to 1 automatically, see Beanstalk protocol). The option will be converted to a int type. Default: 60 Group: common

awaitJob

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder awaitJob(boolean awaitJob)

Whether to wait for job to complete before ack the job from beanstalk. The option is a: boolean type. Default: true Group: consumer

awaitJob

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder awaitJob(String awaitJob)

Whether to wait for job to complete before ack the job from beanstalk. The option will be converted to a boolean type. Default: true Group: consumer

bridgeErrorHandler

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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

onFailure

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder onFailure(BeanstalkEndpointBuilderFactory.BeanstalkCommand onFailure)

Command to use when processing failed. The option is a: org.apache.camel.component.beanstalk.BeanstalkCommand type. Group: consumer

onFailure

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder onFailure(String onFailure)

Command to use when processing failed. The option will be converted to a org.apache.camel.component.beanstalk.BeanstalkCommand type. Group: consumer

sendEmptyMessageWhenIdle

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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

useBlockIO

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder useBlockIO(boolean useBlockIO)

Whether to use blockIO. The option is a: boolean type. Default: true Group: consumer

useBlockIO

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder useBlockIO(String useBlockIO)

Whether to use blockIO. The option will be converted to a boolean type. Default: true Group: consumer

backoffErrorThreshold

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder delay(long delay)

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

delay

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder delay(String delay)

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

greedy

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder initialDelay(long initialDelay)

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

initialDelay

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder initialDelay(String initialDelay)

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

repeatCount

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder scheduler(String scheduler)

To use a cron scheduler from either camel-spring or camel-quartz component. The option is a: java.lang.String type. Default: none Group: scheduler

schedulerProperties

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder startScheduler(boolean startScheduler)

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

startScheduler

default BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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 BeanstalkEndpointBuilderFactory.BeanstalkEndpointConsumerBuilder 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