| // kafka-connector options: START |
| [[camel-consul-kafka-connector-source]] |
| = camel-consul-kafka-connector source configuration |
| |
| When using camel-consul-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-consul-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-consul source connector supports 35 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.source.path.apiEndpoint* | The API endpoint | null | ConfigDef.Importance.HIGH |
| | *camel.source.endpoint.connect TimeoutMillis* | Connect timeout for OkHttpClient | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.consul Client* | Reference to a com.orbitz.consul.Consul in the registry. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.key* | The default key. Can be overridden by CamelConsulKey | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.ping Instance* | Configure if the AgentClient should attempt a ping before returning the Consul instance | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.read TimeoutMillis* | Read timeout for OkHttpClient | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.tags* | Set tags. You can separate multiple tags by comma. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.url* | The Consul agent URL | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.write TimeoutMillis* | Write timeout for OkHttpClient | 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.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.consistency Mode* | The consistencyMode used for queries, default ConsistencyMode.DEFAULT One of: [DEFAULT] [STALE] [CONSISTENT] | "DEFAULT" | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.datacenter* | The data center | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.nearNode* | The near node to use for queries. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.nodeMeta* | The note meta-data to use for queries. | 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.source.endpoint.block Seconds* | The second to wait for a watch event, default 10 seconds | "10" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.first Index* | The first index for watch for, default 0 | "0" | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.recursive* | Recursively watch, default false | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.aclToken* | Sets the ACL token to be used with Consul | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.password* | Sets the password to be used for basic authentication | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.ssl ContextParameters* | SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.userName* | Sets the username to be used for basic authentication | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.consul.acl Token* | Sets the ACL token to be used with Consul | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.consul.datacenter* | The data center | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.consul.password* | Sets the password to be used for basic authentication | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.consul.ssl ContextParameters* | SSL configuration using an org.apache.camel.support.jsse.SSLContextParameters instance. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.consul.url* | The Consul agent URL | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.consul.user Name* | Sets the username to be used for basic authentication | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.consul.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.consul.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.consul.configuration* | Sets the common configuration shared among endpoints | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.consul.use GlobalSslContextParameters* | Enable usage of global SSL context parameters. | false | ConfigDef.Importance.MEDIUM |
| |=== |
| // kafka-connector options: END |
