Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.aws2.kinesis.Kinesis2Component>

All Known Implementing Classes:

Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilderImpl

Enclosing interface:

Aws2KinesisComponentBuilderFactory
```
public static interface Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder
extends ComponentBuilder<org.apache.camel.component.aws2.kinesis.Kinesis2Component>
```
Builder for the AWS Kinesis component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`amazonKinesisClient(software.amazon.awssdk.services.kinesis.KinesisClient amazonKinesisClient)` Amazon Kinesis client to use for all requests for this endpoint.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`autowiredEnabled(boolean autowiredEnabled)` Whether autowiring is enabled.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`cborEnabled(boolean cborEnabled)` This option will set the CBOR_ENABLED property during the execution.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`configuration(org.apache.camel.component.aws2.kinesis.Kinesis2Configuration configuration)` Component configuration.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`iteratorType(software.amazon.awssdk.services.kinesis.model.ShardIteratorType iteratorType)` Defines where in the Kinesis stream to start getting records.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`maxResultsPerRequest(int maxResultsPerRequest)` Maximum number of records that will be fetched in each poll.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`overrideEndpoint(boolean overrideEndpoint)` Set the need for overidding the endpoint.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the Kinesis client.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`proxyPort(Integer proxyPort)` To define a proxy port when instantiating the Kinesis client.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)` To define a proxy protocol when instantiating the Kinesis client.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`region(String region)` The region in which Kinesis Firehose client needs to work.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`secretKey(String secretKey)` Amazon AWS Secret Key.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`sequenceNumber(String sequenceNumber)` The sequence number to start polling from.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`shardClosed(org.apache.camel.component.aws2.kinesis.Kinesis2ShardClosedStrategyEnum shardClosed)` Define what will be the behavior in case of shard closed.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`shardId(String shardId)` Defines which shardId in the Kinesis stream to get records from.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`trustAllCertificates(boolean trustAllCertificates)` If we want to trust all certificates in case of overriding the endpoint.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`uriEndpointOverride(String uriEndpointOverride)` Set the overriding uri endpoint.
`default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder`	`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.

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

- Method Detail
  - amazonKinesisClient
```
default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder amazonKinesisClient(software.amazon.awssdk.services.kinesis.KinesisClient 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
  - cborEnabled
```
default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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
  - configuration
```
default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder configuration(org.apache.camel.component.aws2.kinesis.Kinesis2Configuration configuration)
```
    Component configuration. The option is a: <code>org.apache.camel.component.aws2.kinesis.Kinesis2Configuration</code> type. Group: common
    
    Parameters:
    
    configuration - the value to set
    
    Returns:
    
    the dsl builder
  - overrideEndpoint
```
default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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
  - proxyHost
```
default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder proxyProtocol(software.amazon.awssdk.core.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
  - region
```
default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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
  - uriEndpointOverride
```
default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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
  - bridgeErrorHandler
```
default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder iteratorType(software.amazon.awssdk.services.kinesis.model.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
  - maxResultsPerRequest
```
default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder shardClosed(org.apache.camel.component.aws2.kinesis.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
  - shardId
```
default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder

Method Summary

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

Method Detail

amazonKinesisClient

cborEnabled

configuration

overrideEndpoint

proxyHost

proxyPort

proxyProtocol

region

trustAllCertificates

uriEndpointOverride

useDefaultCredentialsProvider

bridgeErrorHandler

iteratorType

maxResultsPerRequest

sequenceNumber

shardClosed

shardId

lazyStartProducer

autowiredEnabled

accessKey

secretKey