org.apache.camel.builder.component.dsl

Interface AwsMskComponentBuilderFactory.AwsMskComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.aws.msk.MSKComponent>

All Known Implementing Classes:

AwsMskComponentBuilderFactory.AwsMskComponentBuilderImpl

Enclosing interface:

AwsMskComponentBuilderFactory

public static interface AwsMskComponentBuilderFactory.AwsMskComponentBuilder
extends ComponentBuilder<org.apache.camel.component.aws.msk.MSKComponent>

Builder for the AWS Managed Streaming for Apache Kafka (MSK) component.

Method Summary

Modifier and Type	Method and Description
default AwsMskComponentBuilderFactory.AwsMskComponentBuilder	accessKey(String accessKey) Amazon AWS Access Key.
default AwsMskComponentBuilderFactory.AwsMskComponentBuilder	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 AwsMskComponentBuilderFactory.AwsMskComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default AwsMskComponentBuilderFactory.AwsMskComponentBuilder	configuration(org.apache.camel.component.aws.msk.MSKConfiguration configuration) The component configuration.
default AwsMskComponentBuilderFactory.AwsMskComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default AwsMskComponentBuilderFactory.AwsMskComponentBuilder	mskClient(com.amazonaws.services.kafka.AWSKafka mskClient) To use a existing configured AWS MSK as client.
default AwsMskComponentBuilderFactory.AwsMskComponentBuilder	operation(org.apache.camel.component.aws.msk.MSKOperations operation) The operation to perform.
default AwsMskComponentBuilderFactory.AwsMskComponentBuilder	proxyHost(String proxyHost) To define a proxy host when instantiating the MSK client.
default AwsMskComponentBuilderFactory.AwsMskComponentBuilder	proxyPort(Integer proxyPort) To define a proxy port when instantiating the MSK client.
default AwsMskComponentBuilderFactory.AwsMskComponentBuilder	proxyProtocol(com.amazonaws.Protocol proxyProtocol) To define a proxy protocol when instantiating the MSK client.
default AwsMskComponentBuilderFactory.AwsMskComponentBuilder	region(String region) The region in which MSK client needs to work.
default AwsMskComponentBuilderFactory.AwsMskComponentBuilder	secretKey(String secretKey) Amazon AWS Secret Key.

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

build, build, doSetProperty, register

Method Detail

autoDiscoverClient

default AwsMskComponentBuilderFactory.AwsMskComponentBuilder 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

accessKey

default AwsMskComponentBuilderFactory.AwsMskComponentBuilder accessKey(String accessKey)

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

Parameters:

accessKey - the value to set

Returns:

the dsl builder

configuration

default AwsMskComponentBuilderFactory.AwsMskComponentBuilder configuration(org.apache.camel.component.aws.msk.MSKConfiguration configuration)

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

Parameters:

configuration - the value to set

Returns:

the dsl builder

lazyStartProducer

default AwsMskComponentBuilderFactory.AwsMskComponentBuilder 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

mskClient

default AwsMskComponentBuilderFactory.AwsMskComponentBuilder mskClient(com.amazonaws.services.kafka.AWSKafka mskClient)

To use a existing configured AWS MSK as client. The option is a: <code>com.amazonaws.services.kafka.AWSKafka</code> type. Group: producer

Parameters:

mskClient - the value to set

Returns:

the dsl builder

operation

default AwsMskComponentBuilderFactory.AwsMskComponentBuilder operation(org.apache.camel.component.aws.msk.MSKOperations operation)

The operation to perform. The option is a: <code>org.apache.camel.component.aws.msk.MSKOperations</code> type. Group: producer

Parameters:

operation - the value to set

Returns:

the dsl builder

proxyHost

default AwsMskComponentBuilderFactory.AwsMskComponentBuilder proxyHost(String proxyHost)

To define a proxy host when instantiating the MSK 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 AwsMskComponentBuilderFactory.AwsMskComponentBuilder proxyPort(Integer proxyPort)

To define a proxy port when instantiating the MSK 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 AwsMskComponentBuilderFactory.AwsMskComponentBuilder proxyProtocol(com.amazonaws.Protocol proxyProtocol)

To define a proxy protocol when instantiating the MSK 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 AwsMskComponentBuilderFactory.AwsMskComponentBuilder region(String region)

The region in which MSK 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

secretKey

default AwsMskComponentBuilderFactory.AwsMskComponentBuilder secretKey(String secretKey)

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

Parameters:

secretKey - the value to set

Returns:

the dsl builder

autowiredEnabled

default AwsMskComponentBuilderFactory.AwsMskComponentBuilder 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