AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.aws.kinesis.KinesisComponent>

All Known Implementing Classes:

AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilderImpl

Enclosing interface:

AwsKinesisComponentBuilderFactory
```
public static interface AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder
extends ComponentBuilder<org.apache.camel.component.aws.kinesis.KinesisComponent>
```
Builder for the AWS Kinesis component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`amazonKinesisClient(com.amazonaws.services.kinesis.AmazonKinesis amazonKinesisClient)` Amazon Kinesis client to use for all requests for this endpoint.
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`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 AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`autowiredEnabled(boolean autowiredEnabled)` Whether autowiring is enabled.
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`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 AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`configuration(org.apache.camel.component.aws.kinesis.KinesisConfiguration configuration)` The component configuration.
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`iteratorType(com.amazonaws.services.kinesis.model.ShardIteratorType iteratorType)` Defines where in the Kinesis stream to start getting records.
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`maxResultsPerRequest(int maxResultsPerRequest)` Maximum number of records that will be fetched in each poll.
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the Kinesis client.
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`proxyPort(Integer proxyPort)` To define a proxy port when instantiating the Kinesis client.
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`proxyProtocol(com.amazonaws.Protocol proxyProtocol)` To define a proxy protocol when instantiating the Kinesis client.
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`region(String region)` The region in which Kinesis client needs to work.
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`secretKey(String secretKey)` Amazon AWS Secret Key.
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`sequenceNumber(String sequenceNumber)` The sequence number to start polling from.
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`shardClosed(org.apache.camel.component.aws.kinesis.KinesisShardClosedStrategyEnum shardClosed)` Define what will be the behavior in case of shard closed.
`default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder`	`shardId(String shardId)` Defines which shardId in the Kinesis stream to get records from.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - amazonKinesisClient
```
default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder amazonKinesisClient(com.amazonaws.services.kinesis.AmazonKinesis 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
  - autoDiscoverClient
```
default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder 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
  - configuration
```
default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder configuration(org.apache.camel.component.aws.kinesis.KinesisConfiguration configuration)
```
    The component configuration. The option is a: <code>org.apache.camel.component.aws.kinesis.KinesisConfiguration</code> type. Group: common
    
    Parameters:
    
    configuration - the value to set
    
    Returns:
    
    the dsl builder
  - proxyHost
```
default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder 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 AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder 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
  - proxyProtocol
```
default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder proxyProtocol(com.amazonaws.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
  - region
```
default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder 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 AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder 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
  - iteratorType
```
default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder iteratorType(com.amazonaws.services.kinesis.model.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
  - maxResultsPerRequest
```
default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder 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
  - sequenceNumber
```
default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder 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 AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder shardClosed(org.apache.camel.component.aws.kinesis.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
  - shardId
```
default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder 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
  - lazyStartProducer
```
default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder lazyStartProducer(boolean lazyStartProducer)
```
    Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - autowiredEnabled
```
default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder autowiredEnabled(boolean autowiredEnabled)
```
    Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
    
    Parameters:
    
    autowiredEnabled - the value to set
    
    Returns:
    
    the dsl builder
  - accessKey
```
default AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder 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 AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder 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 AwsKinesisComponentBuilderFactory.AwsKinesisComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

amazonKinesisClient

autoDiscoverClient

configuration

proxyHost

proxyPort

proxyProtocol

region

bridgeErrorHandler

iteratorType

maxResultsPerRequest

sequenceNumber

shardClosed

shardId

lazyStartProducer

autowiredEnabled

accessKey

secretKey