blob: bf75a73d015ee99f87b92415287a9aa9a1d6ae60 [file] [log] [blame]
// kafka-connector options: START
[[camel-hazelcast-seda-kafka-connector-sink]]
= camel-hazelcast-seda-kafka-connector sink configuration
When using camel-hazelcast-seda-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-hazelcast-seda-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-hazelcast-seda sink connector supports 16 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.cacheName* | The name of the cache | null | ConfigDef.Importance.HIGH
| *camel.sink.endpoint.default Operation* | To specify a default operation to use, if no operation header has been provided. One of: [put] [delete] [get] [update] [query] [getAll] [clear] [putIfAbsent] [allAll] [removeAll] [retainAll] [evict] [evictAll] [valueCount] [containsKey] [containsValue] [keySet] [removevalue] [increment] [decrement] [setvalue] [destroy] [compareAndSet] [getAndAdd] [add] [offer] [peek] [poll] [remainingCapacity] [drainTo] [removeIf] [take] [publish] [readOnceHeal] [readOnceTail] [capacity] | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.hazelcast Instance* | The hazelcast instance reference which can be used for hazelcast endpoint. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.hazelcast InstanceName* | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.lazyStart Producer* | 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. | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| * camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.concurrent Consumers* | To use concurrent consumers polling from the SEDA queue. | 1 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.onError Delay* | Milliseconds before consumer continues polling after an error has occurred. | 1000 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.poll Timeout* | The timeout used when consuming from the SEDA queue. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. | 1000 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.transacted* | If set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete. | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.transfer Exchange* | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped. | false | ConfigDef.Importance.MEDIUM
| * camel.component.hazelcast-seda.lazy StartProducer* | 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. | false | ConfigDef.Importance.MEDIUM
| * camel.component.hazelcast-seda.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| * camel.component.hazelcast-seda.hazelcast Instance* | The hazelcast instance reference which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance. | null | ConfigDef.Importance.MEDIUM
| * camel.component.hazelcast-seda.hazelcast Mode* | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode, then the node mode will be the default. | "node" | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END