Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder (Camel

All Superinterfaces:

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

All Known Subinterfaces:

Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder

Enclosing interface:

Kinesis2EndpointBuilderFactory
```
public static interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the AWS Kinesis component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder`	`advanced()`
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`amazonKinesisClient(Object amazonKinesisClient)` Amazon Kinesis client to use for all requests for this endpoint.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`amazonKinesisClient(String amazonKinesisClient)` Amazon Kinesis client to use for all requests for this endpoint.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`backoffErrorThreshold(int backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`backoffErrorThreshold(String backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`backoffIdleThreshold(int backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`backoffIdleThreshold(String backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`backoffMultiplier(int backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`backoffMultiplier(String backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`cborEnabled(boolean cborEnabled)` This option will set the CBOR_ENABLED property during the execution.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`cborEnabled(String cborEnabled)` This option will set the CBOR_ENABLED property during the execution.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`delay(long delay)` Milliseconds before the next poll.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`delay(String delay)` Milliseconds before the next poll.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`greedy(boolean greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`greedy(String greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`initialDelay(long initialDelay)` Milliseconds before the first poll starts.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`initialDelay(String initialDelay)` Milliseconds before the first poll starts.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`iteratorType(Kinesis2EndpointBuilderFactory.ShardIteratorType iteratorType)` Defines where in the Kinesis stream to start getting records.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`iteratorType(String iteratorType)` Defines where in the Kinesis stream to start getting records.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`maxResultsPerRequest(int maxResultsPerRequest)` Maximum number of records that will be fetched in each poll.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`maxResultsPerRequest(String maxResultsPerRequest)` Maximum number of records that will be fetched in each poll.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`overrideEndpoint(boolean overrideEndpoint)` Set the need for overidding the endpoint.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`overrideEndpoint(String overrideEndpoint)` Set the need for overidding the endpoint.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the Kinesis client.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`proxyPort(Integer proxyPort)` To define a proxy port when instantiating the Kinesis client.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`proxyPort(String proxyPort)` To define a proxy port when instantiating the Kinesis client.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`proxyProtocol(Kinesis2EndpointBuilderFactory.Protocol proxyProtocol)` To define a proxy protocol when instantiating the Kinesis client.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`proxyProtocol(String proxyProtocol)` To define a proxy protocol when instantiating the Kinesis client.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`region(String region)` The region in which Kinesis Firehose client needs to work.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`repeatCount(long repeatCount)` Specifies a maximum limit of number of fires.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`repeatCount(String repeatCount)` Specifies a maximum limit of number of fires.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`resumeStrategy(Object resumeStrategy)` Defines a resume strategy for AWS Kinesis.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`resumeStrategy(String resumeStrategy)` Defines a resume strategy for AWS Kinesis.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`runLoggingLevel(String runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`scheduledExecutorService(String scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`scheduler(Object scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`scheduler(String scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`schedulerProperties(Map values)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`schedulerProperties(String key, Object value)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`secretKey(String secretKey)` Amazon AWS Secret Key.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`sequenceNumber(String sequenceNumber)` The sequence number to start polling from.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`shardClosed(Kinesis2EndpointBuilderFactory.Kinesis2ShardClosedStrategyEnum shardClosed)` Define what will be the behavior in case of shard closed.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`shardClosed(String shardClosed)` Define what will be the behavior in case of shard closed.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`shardId(String shardId)` Defines which shardId in the Kinesis stream to get records from.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`startScheduler(boolean startScheduler)` Whether the scheduler should be auto started.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`startScheduler(String startScheduler)` Whether the scheduler should be auto started.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`timeUnit(String timeUnit)` Time unit for initialDelay and delay options.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`timeUnit(TimeUnit timeUnit)` Time unit for initialDelay and delay options.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`trustAllCertificates(boolean trustAllCertificates)` If we want to trust all certificates in case of overriding the endpoint.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`trustAllCertificates(String trustAllCertificates)` If we want to trust all certificates in case of overriding the endpoint.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`uriEndpointOverride(String uriEndpointOverride)` Set the overriding uri endpoint.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)` Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`useDefaultCredentialsProvider(String useDefaultCredentialsProvider)` Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`useFixedDelay(boolean useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder`	`useFixedDelay(String useFixedDelay)` Controls if fixed delay or fixed rate is used.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

- Method Detail
  - advanced
```
default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder advanced()
```
  - amazonKinesisClient
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder amazonKinesisClient(Object amazonKinesisClient)
```
    Amazon Kinesis client to use for all requests for this endpoint. The option is a: <code>software.amazon.awssdk.services.kinesis.KinesisClient</code> type. Group: common
    
    Parameters:
    
    amazonKinesisClient - the value to set
    
    Returns:
    
    the dsl builder
  - amazonKinesisClient
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder amazonKinesisClient(String amazonKinesisClient)
```
    Amazon Kinesis client to use for all requests for this endpoint. The option will be converted to a <code>software.amazon.awssdk.services.kinesis.KinesisClient</code> type. Group: common
    
    Parameters:
    
    amazonKinesisClient - the value to set
    
    Returns:
    
    the dsl builder
  - cborEnabled
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder cborEnabled(boolean cborEnabled)
```
    This option will set the CBOR_ENABLED property during the execution. The option is a: <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    cborEnabled - the value to set
    
    Returns:
    
    the dsl builder
  - cborEnabled
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder cborEnabled(String cborEnabled)
```
    This option will set the CBOR_ENABLED property during the execution. The option will be converted to a <code>boolean</code> type. Default: true Group: common
    
    Parameters:
    
    cborEnabled - the value to set
    
    Returns:
    
    the dsl builder
  - overrideEndpoint
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder overrideEndpoint(boolean overrideEndpoint)
```
    Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a: <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    overrideEndpoint - the value to set
    
    Returns:
    
    the dsl builder
  - overrideEndpoint
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder overrideEndpoint(String overrideEndpoint)
```
    Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option will be converted to a <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    overrideEndpoint - the value to set
    
    Returns:
    
    the dsl builder
  - proxyHost
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder proxyProtocol(Kinesis2EndpointBuilderFactory.Protocol proxyProtocol)
```
    To define a proxy protocol when instantiating the Kinesis client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: common
    
    Parameters:
    
    proxyProtocol - the value to set
    
    Returns:
    
    the dsl builder
  - proxyProtocol
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder proxyProtocol(String proxyProtocol)
```
    To define a proxy protocol when instantiating the Kinesis client. The option will be converted to a <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: common
    
    Parameters:
    
    proxyProtocol - the value to set
    
    Returns:
    
    the dsl builder
  - region
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder region(String region)
```
    The region in which Kinesis Firehose client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id(). The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    region - the value to set
    
    Returns:
    
    the dsl builder
  - trustAllCertificates
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder trustAllCertificates(boolean trustAllCertificates)
```
    If we want to trust all certificates in case of overriding the endpoint. The option is a: <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    trustAllCertificates - the value to set
    
    Returns:
    
    the dsl builder
  - trustAllCertificates
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder trustAllCertificates(String trustAllCertificates)
```
    If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    trustAllCertificates - the value to set
    
    Returns:
    
    the dsl builder
  - uriEndpointOverride
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder uriEndpointOverride(String uriEndpointOverride)
```
    Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: <code>java.lang.String</code> type. Group: common
    
    Parameters:
    
    uriEndpointOverride - the value to set
    
    Returns:
    
    the dsl builder
  - useDefaultCredentialsProvider
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
```
    Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option is a: <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    useDefaultCredentialsProvider - the value to set
    
    Returns:
    
    the dsl builder
  - useDefaultCredentialsProvider
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider)
```
    Set whether the Kinesis client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option will be converted to a <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    useDefaultCredentialsProvider - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder iteratorType(Kinesis2EndpointBuilderFactory.ShardIteratorType iteratorType)
```
    Defines where in the Kinesis stream to start getting records. The option is a: <code>software.amazon.awssdk.services.kinesis.model.ShardIteratorType</code> type. Default: TRIM_HORIZON Group: consumer
    
    Parameters:
    
    iteratorType - the value to set
    
    Returns:
    
    the dsl builder
  - iteratorType
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder iteratorType(String iteratorType)
```
    Defines where in the Kinesis stream to start getting records. The option will be converted to a <code>software.amazon.awssdk.services.kinesis.model.ShardIteratorType</code> type. Default: TRIM_HORIZON Group: consumer
    
    Parameters:
    
    iteratorType - the value to set
    
    Returns:
    
    the dsl builder
  - maxResultsPerRequest
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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
  - resumeStrategy
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder resumeStrategy(Object resumeStrategy)
```
    Defines a resume strategy for AWS Kinesis. The default strategy reads the sequenceNumber if provided. The option is a: <code>org.apache.camel.component.aws2.kinesis.consumer.KinesisResumeStrategy</code> type. Default: KinesisUserConfigurationResumeStrategy Group: consumer
    
    Parameters:
    
    resumeStrategy - the value to set
    
    Returns:
    
    the dsl builder
  - resumeStrategy
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder resumeStrategy(String resumeStrategy)
```
    Defines a resume strategy for AWS Kinesis. The default strategy reads the sequenceNumber if provided. The option will be converted to a <code>org.apache.camel.component.aws2.kinesis.consumer.KinesisResumeStrategy</code> type. Default: KinesisUserConfigurationResumeStrategy Group: consumer
    
    Parameters:
    
    resumeStrategy - the value to set
    
    Returns:
    
    the dsl builder
  - sendEmptyMessageWhenIdle
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder shardClosed(Kinesis2EndpointBuilderFactory.Kinesis2ShardClosedStrategyEnum 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.aws2.kinesis.Kinesis2ShardClosedStrategyEnum</code> type. Default: ignore Group: consumer
    
    Parameters:
    
    shardClosed - the value to set
    
    Returns:
    
    the dsl builder
  - shardClosed
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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.aws2.kinesis.Kinesis2ShardClosedStrategyEnum</code> type. Default: ignore Group: consumer
    
    Parameters:
    
    shardClosed - the value to set
    
    Returns:
    
    the dsl builder
  - shardId
```
default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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<java.lang.String, java.lang.Object></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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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<java.lang.String, java.lang.Object></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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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

Interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

amazonKinesisClient

amazonKinesisClient

cborEnabled

cborEnabled

overrideEndpoint

overrideEndpoint

proxyHost

proxyPort

proxyPort

proxyProtocol

proxyProtocol

region

trustAllCertificates

trustAllCertificates

uriEndpointOverride

useDefaultCredentialsProvider

useDefaultCredentialsProvider

bridgeErrorHandler

bridgeErrorHandler

iteratorType

iteratorType

maxResultsPerRequest

maxResultsPerRequest

resumeStrategy

resumeStrategy

sendEmptyMessageWhenIdle

sendEmptyMessageWhenIdle

sequenceNumber

shardClosed

shardClosed

shardId

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

accessKey

secretKey