org.apache.camel.builder.endpoint.dsl

Interface ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

ZendeskEndpointBuilderFactory.ZendeskEndpointBuilder

Enclosing interface:

ZendeskEndpointBuilderFactory

public static interface ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the Zendesk component.

Method Summary

Modifier and Type	Method and Description
default ZendeskEndpointBuilderFactory.AdvancedZendeskEndpointConsumerBuilder	advanced()
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	backoffErrorThreshold(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	backoffErrorThreshold(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	backoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	backoffIdleThreshold(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	backoffMultiplier(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	backoffMultiplier(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	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 ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	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 ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	delay(long delay) Milliseconds before the next poll.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	delay(String delay) Milliseconds before the next poll.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	greedy(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	greedy(String greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	inBody(String inBody) Sets the name of a parameter to be passed in the exchange In Body.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	initialDelay(long initialDelay) Milliseconds before the first poll starts.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	initialDelay(String initialDelay) Milliseconds before the first poll starts.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	oauthToken(String oauthToken) The OAuth token.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	password(String password) The password.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	repeatCount(long repeatCount) Specifies a maximum limit of number of fires.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	repeatCount(String repeatCount) Specifies a maximum limit of number of fires.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	scheduledExecutorService(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	scheduler(Object scheduler) To use a cron scheduler from either camel-spring or camel-quartz component.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	scheduler(String scheduler) To use a cron scheduler from either camel-spring or camel-quartz component.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	schedulerProperties(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	schedulerProperties(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	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 ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	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 ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	serverUrl(String serverUrl) The server URL to connect.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	startScheduler(boolean startScheduler) Whether the scheduler should be auto started.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	startScheduler(String startScheduler) Whether the scheduler should be auto started.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	timeUnit(String timeUnit) Time unit for initialDelay and delay options.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	timeUnit(TimeUnit timeUnit) Time unit for initialDelay and delay options.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	token(String token) The security token.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	useFixedDelay(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	useFixedDelay(String useFixedDelay) Controls if fixed delay or fixed rate is used.
default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder	username(String username) The user name.

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 ZendeskEndpointBuilderFactory.AdvancedZendeskEndpointConsumerBuilder advanced()

inBody

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder inBody(String inBody)

Sets the name of a parameter to be passed in the exchange In Body. The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

inBody - the value to set

Returns:

the dsl builder

serverUrl

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder serverUrl(String serverUrl)

The server URL to connect. The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

serverUrl - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

sendEmptyMessageWhenIdle

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer

Parameters:

sendEmptyMessageWhenIdle - the value to set

Returns:

the dsl builder

sendEmptyMessageWhenIdle

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer

Parameters:

sendEmptyMessageWhenIdle - the value to set

Returns:

the dsl builder

backoffErrorThreshold

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold)

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler

Parameters:

backoffErrorThreshold - the value to set

Returns:

the dsl builder

backoffErrorThreshold

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold)

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler

Parameters:

backoffErrorThreshold - the value to set

Returns:

the dsl builder

backoffIdleThreshold

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler

Parameters:

backoffIdleThreshold - the value to set

Returns:

the dsl builder

backoffIdleThreshold

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold)

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler

Parameters:

backoffIdleThreshold - the value to set

Returns:

the dsl builder

backoffMultiplier

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder backoffMultiplier(int backoffMultiplier)

To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: <code>int</code> type. Group: scheduler

Parameters:

backoffMultiplier - the value to set

Returns:

the dsl builder

backoffMultiplier

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder backoffMultiplier(String backoffMultiplier)

To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a <code>int</code> type. Group: scheduler

Parameters:

backoffMultiplier - the value to set

Returns:

the dsl builder

delay

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder delay(long delay)

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

Parameters:

delay - the value to set

Returns:

the dsl builder

delay

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder delay(String delay)

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

Parameters:

delay - the value to set

Returns:

the dsl builder

greedy

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder greedy(boolean greedy)

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler

Parameters:

greedy - the value to set

Returns:

the dsl builder

greedy

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder greedy(String greedy)

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler

Parameters:

greedy - the value to set

Returns:

the dsl builder

initialDelay

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder initialDelay(long initialDelay)

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

Parameters:

initialDelay - the value to set

Returns:

the dsl builder

initialDelay

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder initialDelay(String initialDelay)

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

Parameters:

initialDelay - the value to set

Returns:

the dsl builder

repeatCount

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder repeatCount(long repeatCount)

Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: <code>long</code> type. Default: 0 Group: scheduler

Parameters:

repeatCount - the value to set

Returns:

the dsl builder

repeatCount

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder repeatCount(String repeatCount)

Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler

Parameters:

repeatCount - the value to set

Returns:

the dsl builder

runLoggingLevel

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler

Parameters:

runLoggingLevel - the value to set

Returns:

the dsl builder

runLoggingLevel

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder runLoggingLevel(String runLoggingLevel)

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler

Parameters:

runLoggingLevel - the value to set

Returns:

the dsl builder

scheduledExecutorService

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)

Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler

Parameters:

scheduledExecutorService - the value to set

Returns:

the dsl builder

scheduledExecutorService

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService)

Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler

Parameters:

scheduledExecutorService - the value to set

Returns:

the dsl builder

scheduler

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder scheduler(Object scheduler)

To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler

Parameters:

scheduler - the value to set

Returns:

the dsl builder

scheduler

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder scheduler(String scheduler)

To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler

Parameters:

scheduler - the value to set

Returns:

the dsl builder

schedulerProperties

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder schedulerProperties(String key,
                                                                                         Object value)

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

schedulerProperties

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder schedulerProperties(Map values)

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler

Parameters:

values - the values

Returns:

the dsl builder

startScheduler

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder startScheduler(boolean startScheduler)

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

Parameters:

startScheduler - the value to set

Returns:

the dsl builder

startScheduler

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder startScheduler(String startScheduler)

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

Parameters:

startScheduler - the value to set

Returns:

the dsl builder

timeUnit

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)

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

Parameters:

timeUnit - the value to set

Returns:

the dsl builder

timeUnit

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder timeUnit(String timeUnit)

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

Parameters:

timeUnit - the value to set

Returns:

the dsl builder

useFixedDelay

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler

Parameters:

useFixedDelay - the value to set

Returns:

the dsl builder

useFixedDelay

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder useFixedDelay(String useFixedDelay)

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler

Parameters:

useFixedDelay - the value to set

Returns:

the dsl builder

oauthToken

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder oauthToken(String oauthToken)

The OAuth token. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

oauthToken - the value to set

Returns:

the dsl builder

password

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder password(String password)

The password. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

password - the value to set

Returns:

the dsl builder

token

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder token(String token)

The security token. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

token - the value to set

Returns:

the dsl builder

username

default ZendeskEndpointBuilderFactory.ZendeskEndpointConsumerBuilder username(String username)

The user name. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

username - the value to set

Returns:

the dsl builder