blob: dfd9c3cc51be087656ca4b70145142899bfca4fd [file] [log] [blame]
// kafka-connector options: START
[[camel-gora-kafka-connector-source]]
= camel-gora-kafka-connector source configuration
When using camel-gora-kafka-connector as source 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-gora-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-gora source connector supports 24 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.name* | Instance name | null | ConfigDef.Importance.HIGH
| *camel.source.endpoint.data StoreClass* | The type of the dataStore | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.keyClass* | The type class of the key | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.value Class* | The type of the value | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.bridge ErrorHandler* | 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. | false | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.concurrent Consumers* | Number of concurrent consumers | 1 | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.endKey* | The End Key | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.endTime* | The End Time | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.fields* | The Fields | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.keyRange From* | The Key Range From | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.keyRange To* | The Key Range To | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.limit* | The Limit | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.startKey* | The Start Key | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.start Time* | The Start Time | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.time RangeFrom* | The Time Range From | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.time RangeTo* | The Time Range To | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.timestamp* | The Timestamp | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.exception Handler* | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.exchange Pattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM
| *camel.source.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.source.endpoint.hadoop Configuration* | Hadoop Configuration | null | ConfigDef.Importance.MEDIUM
| * camel.source.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.component.gora.bridge ErrorHandler* | 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. | false | ConfigDef.Importance.MEDIUM
| *camel.component.gora.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
|===
// kafka-connector options: END