org.apache.camel.builder.endpoint.dsl

Interface KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

KinesisEndpointBuilderFactory.KinesisEndpointBuilder

Enclosing interface:

KinesisEndpointBuilderFactory

public static interface KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the AWS Kinesis component.

Method Summary

Modifier and Type	Method and Description
default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder	accessKey(String accessKey) Amazon AWS Access Key.
default KinesisEndpointBuilderFactory.AdvancedKinesisEndpointProducerBuilder	advanced()
default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder	amazonKinesisClient(Object amazonKinesisClient) Amazon Kinesis client to use for all requests for this endpoint.
default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder	amazonKinesisClient(String amazonKinesisClient) Amazon Kinesis client to use for all requests for this endpoint.
default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder	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 KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder	autoDiscoverClient(String 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 KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder	proxyHost(String proxyHost) To define a proxy host when instantiating the Kinesis client.
default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder	proxyPort(Integer proxyPort) To define a proxy port when instantiating the Kinesis client.
default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder	proxyPort(String proxyPort) To define a proxy port when instantiating the Kinesis client.
default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder	proxyProtocol(KinesisEndpointBuilderFactory.Protocol proxyProtocol) To define a proxy protocol when instantiating the Kinesis client.
default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder	proxyProtocol(String proxyProtocol) To define a proxy protocol when instantiating the Kinesis client.
default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder	region(String region) The region in which Kinesis client needs to work.
default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder	secretKey(String secretKey) Amazon AWS Secret Key.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default KinesisEndpointBuilderFactory.AdvancedKinesisEndpointProducerBuilder advanced()

amazonKinesisClient

default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder amazonKinesisClient(Object 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

amazonKinesisClient

default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder amazonKinesisClient(String amazonKinesisClient)

Amazon Kinesis client to use for all requests for this endpoint. The option will be converted to a <code>com.amazonaws.services.kinesis.AmazonKinesis</code> type. Group: common

Parameters:

amazonKinesisClient - the value to set

Returns:

the dsl builder

autoDiscoverClient

default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder 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

autoDiscoverClient

default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder autoDiscoverClient(String 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 will be converted to a <code>boolean</code> type. Default: true Group: common

Parameters:

autoDiscoverClient - the value to set

Returns:

the dsl builder

proxyHost

default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder proxyProtocol(KinesisEndpointBuilderFactory.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

proxyProtocol

default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder proxyProtocol(String proxyProtocol)

To define a proxy protocol when instantiating the Kinesis client. The option will be converted to a <code>com.amazonaws.Protocol</code> type. Default: HTTPS Group: common

Parameters:

proxyProtocol - the value to set

Returns:

the dsl builder

region

default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder 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

lazyStartProducer

default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder 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

lazyStartProducer

default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder lazyStartProducer(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

accessKey

default KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder 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 KinesisEndpointBuilderFactory.KinesisEndpointProducerBuilder 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