org.apache.camel.builder.component.dsl

Interface AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.aws.firehose.KinesisFirehoseComponent>

All Known Implementing Classes:

AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilderImpl

Enclosing interface:

AwsKinesisFirehoseComponentBuilderFactory

public static interface AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder
extends ComponentBuilder<org.apache.camel.component.aws.firehose.KinesisFirehoseComponent>

Builder for the AWS Kinesis Firehose component.

Method Summary

Modifier and Type	Method and Description
default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder	accessKey(String accessKey) Amazon AWS Access Key.
default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder	amazonKinesisFirehoseClient(com.amazonaws.services.kinesisfirehose.AmazonKinesisFirehose amazonKinesisFirehoseClient) Amazon Kinesis Firehose client to use for all requests for this endpoint.
default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder	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 AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder	configuration(org.apache.camel.component.aws.firehose.KinesisFirehoseConfiguration configuration) The component configuration.
default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder	proxyHost(String proxyHost) To define a proxy host when instantiating the Kinesis Firehose client.
default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder	proxyPort(Integer proxyPort) To define a proxy port when instantiating the Kinesis Firehose client.
default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder	proxyProtocol(com.amazonaws.Protocol proxyProtocol) To define a proxy protocol when instantiating the Kinesis Firehose client.
default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder	region(String region) The region in which Kinesis client needs to work.
default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder	secretKey(String secretKey) Amazon AWS Secret Key.

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

build, build, doSetProperty, register

Method Detail

amazonKinesisFirehoseClient

default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder amazonKinesisFirehoseClient(com.amazonaws.services.kinesisfirehose.AmazonKinesisFirehose amazonKinesisFirehoseClient)

Amazon Kinesis Firehose client to use for all requests for this endpoint. The option is a: <code>com.amazonaws.services.kinesisfirehose.AmazonKinesisFirehose</code> type. Group: producer

Parameters:

amazonKinesisFirehoseClient - the value to set

Returns:

the dsl builder

autoDiscoverClient

default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder 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 AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder configuration(org.apache.camel.component.aws.firehose.KinesisFirehoseConfiguration configuration)

The component configuration. The option is a: <code>org.apache.camel.component.aws.firehose.KinesisFirehoseConfiguration</code> type. Group: producer

Parameters:

configuration - the value to set

Returns:

the dsl builder

lazyStartProducer

default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder 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

proxyHost

default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder proxyHost(String proxyHost)

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

Parameters:

proxyHost - the value to set

Returns:

the dsl builder

proxyPort

default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder proxyPort(Integer proxyPort)

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

Parameters:

proxyPort - the value to set

Returns:

the dsl builder

proxyProtocol

default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder proxyProtocol(com.amazonaws.Protocol proxyProtocol)

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

Parameters:

proxyProtocol - the value to set

Returns:

the dsl builder

region

default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder 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: producer

Parameters:

region - the value to set

Returns:

the dsl builder

autowiredEnabled

default AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder 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 AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder 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 AwsKinesisFirehoseComponentBuilderFactory.AwsKinesisFirehoseComponentBuilder 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