org.apache.camel.builder.endpoint.dsl

Interface KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

KinesisEndpointBuilderFactory.KinesisEndpointBuilder

Enclosing interface:

KinesisEndpointBuilderFactory

public static interface KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the AWS Kinesis component.

Method Summary

Modifier and Type	Method and Description
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	accessKey(String accessKey) Amazon AWS Access Key.
default KinesisEndpointBuilderFactory.AdvancedKinesisEndpointConsumerBuilder	advanced()
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	amazonKinesisClient(Object amazonKinesisClient) Amazon Kinesis client to use for all requests for this endpoint.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	amazonKinesisClient(String amazonKinesisClient) Amazon Kinesis client to use for all requests for this endpoint.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	autoDiscoverClient(boolean autoDiscoverClient) Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	autoDiscoverClient(String autoDiscoverClient) Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	backoffErrorThreshold(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	backoffErrorThreshold(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	backoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	backoffIdleThreshold(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	backoffMultiplier(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	backoffMultiplier(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	delay(long delay) Milliseconds before the next poll.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	delay(String delay) Milliseconds before the next poll.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	greedy(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	greedy(String greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	initialDelay(long initialDelay) Milliseconds before the first poll starts.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	initialDelay(String initialDelay) Milliseconds before the first poll starts.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	iteratorType(KinesisEndpointBuilderFactory.ShardIteratorType iteratorType) Defines where in the Kinesis stream to start getting records.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	iteratorType(String iteratorType) Defines where in the Kinesis stream to start getting records.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	maxResultsPerRequest(int maxResultsPerRequest) Maximum number of records that will be fetched in each poll.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	maxResultsPerRequest(String maxResultsPerRequest) Maximum number of records that will be fetched in each poll.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	proxyHost(String proxyHost) To define a proxy host when instantiating the Kinesis client.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	proxyPort(Integer proxyPort) To define a proxy port when instantiating the Kinesis client.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	proxyPort(String proxyPort) To define a proxy port when instantiating the Kinesis client.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	proxyProtocol(KinesisEndpointBuilderFactory.Protocol proxyProtocol) To define a proxy protocol when instantiating the Kinesis client.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	proxyProtocol(String proxyProtocol) To define a proxy protocol when instantiating the Kinesis client.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	region(String region) The region in which Kinesis client needs to work.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	repeatCount(long repeatCount) Specifies a maximum limit of number of fires.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	repeatCount(String repeatCount) Specifies a maximum limit of number of fires.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	scheduledExecutorService(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	scheduler(Object scheduler) To use a cron scheduler from either camel-spring or camel-quartz component.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	scheduler(String scheduler) To use a cron scheduler from either camel-spring or camel-quartz component.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	schedulerProperties(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	schedulerProperties(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	secretKey(String secretKey) Amazon AWS Secret Key.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	sequenceNumber(String sequenceNumber) The sequence number to start polling from.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	shardClosed(KinesisEndpointBuilderFactory.KinesisShardClosedStrategyEnum shardClosed) Define what will be the behavior in case of shard closed.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	shardClosed(String shardClosed) Define what will be the behavior in case of shard closed.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	shardId(String shardId) Defines which shardId in the Kinesis stream to get records from.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	startScheduler(boolean startScheduler) Whether the scheduler should be auto started.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	startScheduler(String startScheduler) Whether the scheduler should be auto started.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	timeUnit(String timeUnit) Time unit for initialDelay and delay options.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	timeUnit(TimeUnit timeUnit) Time unit for initialDelay and delay options.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	useFixedDelay(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.
default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder	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 KinesisEndpointBuilderFactory.AdvancedKinesisEndpointConsumerBuilder advanced()

amazonKinesisClient

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder amazonKinesisClient(Object amazonKinesisClient)

Amazon Kinesis client to use for all requests for this endpoint. The option is a: <code>com.amazonaws.services.kinesis.AmazonKinesis</code> type. Group: common

Parameters:

amazonKinesisClient - the value to set

Returns:

the dsl builder

amazonKinesisClient

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder amazonKinesisClient(String amazonKinesisClient)

Amazon Kinesis client to use for all requests for this endpoint. The option will be converted to a <code>com.amazonaws.services.kinesis.AmazonKinesis</code> type. Group: common

Parameters:

amazonKinesisClient - the value to set

Returns:

the dsl builder

autoDiscoverClient

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder autoDiscoverClient(boolean autoDiscoverClient)

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option is a: <code>boolean</code> type. Default: true Group: common

Parameters:

autoDiscoverClient - the value to set

Returns:

the dsl builder

autoDiscoverClient

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder autoDiscoverClient(String autoDiscoverClient)

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Parameters:

autoDiscoverClient - the value to set

Returns:

the dsl builder

proxyHost

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder proxyHost(String proxyHost)

To define a proxy host when instantiating the Kinesis client. The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

proxyHost - the value to set

Returns:

the dsl builder

proxyPort

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder proxyPort(Integer proxyPort)

To define a proxy port when instantiating the Kinesis client. The option is a: <code>java.lang.Integer</code> type. Group: common

Parameters:

proxyPort - the value to set

Returns:

the dsl builder

proxyPort

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder proxyPort(String proxyPort)

To define a proxy port when instantiating the Kinesis client. The option will be converted to a <code>java.lang.Integer</code> type. Group: common

Parameters:

proxyPort - the value to set

Returns:

the dsl builder

proxyProtocol

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder proxyProtocol(KinesisEndpointBuilderFactory.Protocol proxyProtocol)

To define a proxy protocol when instantiating the Kinesis client. The option is a: <code>com.amazonaws.Protocol</code> type. Default: HTTPS Group: common

Parameters:

proxyProtocol - the value to set

Returns:

the dsl builder

proxyProtocol

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder proxyProtocol(String proxyProtocol)

To define a proxy protocol when instantiating the Kinesis client. The option will be converted to a <code>com.amazonaws.Protocol</code> type. Default: HTTPS Group: common

Parameters:

proxyProtocol - the value to set

Returns:

the dsl builder

region

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder region(String region)

The region in which Kinesis client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1)You'll need to use the name Regions.EU_WEST_1.name(). The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

region - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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

iteratorType

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder iteratorType(KinesisEndpointBuilderFactory.ShardIteratorType iteratorType)

Defines where in the Kinesis stream to start getting records. The option is a: <code>com.amazonaws.services.kinesis.model.ShardIteratorType</code> type. Default: TRIM_HORIZON Group: consumer

Parameters:

iteratorType - the value to set

Returns:

the dsl builder

iteratorType

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder iteratorType(String iteratorType)

Defines where in the Kinesis stream to start getting records. The option will be converted to a <code>com.amazonaws.services.kinesis.model.ShardIteratorType</code> type. Default: TRIM_HORIZON Group: consumer

Parameters:

iteratorType - the value to set

Returns:

the dsl builder

maxResultsPerRequest

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder maxResultsPerRequest(int maxResultsPerRequest)

Maximum number of records that will be fetched in each poll. The option is a: <code>int</code> type. Default: 1 Group: consumer

Parameters:

maxResultsPerRequest - the value to set

Returns:

the dsl builder

maxResultsPerRequest

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder maxResultsPerRequest(String maxResultsPerRequest)

Maximum number of records that will be fetched in each poll. The option will be converted to a <code>int</code> type. Default: 1 Group: consumer

Parameters:

maxResultsPerRequest - the value to set

Returns:

the dsl builder

sendEmptyMessageWhenIdle

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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

sequenceNumber

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder sequenceNumber(String sequenceNumber)

The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

sequenceNumber - the value to set

Returns:

the dsl builder

shardClosed

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder shardClosed(KinesisEndpointBuilderFactory.KinesisShardClosedStrategyEnum shardClosed)

Define what will be the behavior in case of shard closed. Possible value are ignore, silent and fail. In case of ignore a message will be logged and the consumer will restart from the beginning,in case of silent there will be no logging and the consumer will start from the beginning,in case of fail a ReachedClosedStateException will be raised. The option is a: <code>org.apache.camel.component.aws.kinesis.KinesisShardClosedStrategyEnum</code> type. Default: ignore Group: consumer

Parameters:

shardClosed - the value to set

Returns:

the dsl builder

shardClosed

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder shardClosed(String shardClosed)

Define what will be the behavior in case of shard closed. Possible value are ignore, silent and fail. In case of ignore a message will be logged and the consumer will restart from the beginning,in case of silent there will be no logging and the consumer will start from the beginning,in case of fail a ReachedClosedStateException will be raised. The option will be converted to a <code>org.apache.camel.component.aws.kinesis.KinesisShardClosedStrategyEnum</code> type. Default: ignore Group: consumer

Parameters:

shardClosed - the value to set

Returns:

the dsl builder

shardId

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder shardId(String shardId)

Defines which shardId in the Kinesis stream to get records from. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

shardId - the value to set

Returns:

the dsl builder

backoffErrorThreshold

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder 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

accessKey

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder accessKey(String accessKey)

Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

accessKey - the value to set

Returns:

the dsl builder

secretKey

default KinesisEndpointBuilderFactory.KinesisEndpointConsumerBuilder secretKey(String secretKey)

Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

secretKey - the value to set

Returns:

the dsl builder