camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davscl...@apache.org
Subject camel git commit: Polished docs
Date Sat, 11 Mar 2017 21:04:34 GMT
Repository: camel
Updated Branches:
  refs/heads/master 09fb6426d -> 388654964


Polished docs


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/38865496
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/38865496
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/38865496

Branch: refs/heads/master
Commit: 388654964680523581e767df6c39a4b21a3f913d
Parents: 09fb642
Author: Claus Ibsen <davsclaus@apache.org>
Authored: Sat Mar 11 22:04:26 2017 +0100
Committer: Claus Ibsen <davsclaus@apache.org>
Committed: Sat Mar 11 22:04:26 2017 +0100

----------------------------------------------------------------------
 components/camel-kafka/src/main/docs/kafka-component.adoc       | 4 ++--
 .../org/apache/camel/component/kafka/KafkaConfiguration.java    | 5 +++++
 2 files changed, 7 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/38865496/components/camel-kafka/src/main/docs/kafka-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-kafka/src/main/docs/kafka-component.adoc b/components/camel-kafka/src/main/docs/kafka-component.adoc
index 729fdf6..d24345c 100644
--- a/components/camel-kafka/src/main/docs/kafka-component.adoc
+++ b/components/camel-kafka/src/main/docs/kafka-component.adoc
@@ -61,7 +61,7 @@ with the following path and query parameters:
 [width="100%",cols="2,1,1m,6",options="header"]
 |=======================================================================
 | Name | Default | Java Type | Description
-| topic |  | String | *Required* Name of the topic to use.
+| topic |  | String | *Required* Name of the topic to use. On the consumer you can use comma
to separate multiple topics. A producer can only send a message to a single topic.
 |=======================================================================
 
 #### Query Parameters (82 parameters):
@@ -71,7 +71,7 @@ with the following path and query parameters:
 | Name | Group | Default | Java Type | Description
 | brokers | common |  | String | URL of the Kafka brokers to use. The format is host1:port1host2:port2
and the list can be a subset of brokers or a VIP pointing to a subset of brokers. This option
is known as bootstrap.servers in the Kafka documentation.
 | clientId | common |  | String | The client id is a user-specified string sent in each request
to help trace calls. It should logically identify the application making the request.
-| groupId | common |  | String | A string that uniquely identifies the group of consumer
processes to which this consumer belongs. By setting the same group id multiple processes
indicate that they are all part of the same consumer group.
+| groupId | common |  | String | A string that uniquely identifies the group of consumer
processes to which this consumer belongs. By setting the same group id multiple processes
indicate that they are all part of the same consumer group. This option is required for consumers.
 | partitioner | common | org.apache.kafka.clients.producer.internals.DefaultPartitioner |
String | The partitioner class for partitioning messages amongst sub-topics. The default partitioner
is based on the hash of the key.
 | autoCommitEnable | consumer | true | Boolean | If true periodically commit to ZooKeeper
the offset of messages already fetched by the consumer. This committed offset will be used
when the process fails as the position from which the new consumer will begin.
 | autoCommitIntervalMs | consumer | 5000 | Integer | The frequency in ms that the consumer
offsets are committed to zookeeper.

http://git-wip-us.apache.org/repos/asf/camel/blob/38865496/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaConfiguration.java
----------------------------------------------------------------------
diff --git a/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaConfiguration.java
b/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaConfiguration.java
index 064c087..2afb3a8 100644
--- a/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaConfiguration.java
+++ b/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaConfiguration.java
@@ -470,6 +470,8 @@ public class KafkaConfiguration {
     /**
      * A string that uniquely identifies the group of consumer processes to which this consumer
belongs.
      * By setting the same group id multiple processes indicate that they are all part of
the same consumer group.
+     *
+     * This option is required for consumers.
      */
     public void setGroupId(String groupId) {
         this.groupId = groupId;
@@ -492,6 +494,9 @@ public class KafkaConfiguration {
 
     /**
      * Name of the topic to use.
+     *
+     * On the consumer you can use comma to separate multiple topics.
+     * A producer can only send a message to a single topic.
      */
     public void setTopic(String topic) {
         this.topic = topic;


Mime
View raw message