Skip to content

Commit

Permalink
Merge pull request #48 from sadasivaprasad-trellix/feature/kafka-head…
Browse files Browse the repository at this point in the history
…er-changes-release-version-change

Feature/kafka header changes release version change
  • Loading branch information
umanekar-mcafee committed Nov 30, 2022
2 parents 75c770f + 92fa2c0 commit 3740a02
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 28 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To start using the OpenDXL Databus Java client library:
## Maven Repository

Visit the [OpenDXL Databus Java Client Maven Repository](https://search.maven.org/artifact/com.opendxl/dxldatabusclient) for
access to all released versions including the appropriate dependency syntax for a large number of management
access to all released versions including the appropriate dependency syntax for a large number of management
systems (Maven, Gradle, SBT, Ivy, Grape, etc.).

Maven:
Expand All @@ -36,12 +36,12 @@ Maven:
<dependency>
<groupId>com.opendxl</groupId>
<artifactId>dxldatabusclient</artifactId>
<version>2.4.9</version>
<version>2.4.10</version>
</dependency>
```
or Gradle:
```groovy
compile 'com.opendxl:dxldatabusclient:2.4.9'
compile 'com.opendxl:dxldatabusclient:2.4.10'
```

## Bugs and Feedback
Expand Down
44 changes: 22 additions & 22 deletions docs/CLI-Example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,33 +7,33 @@ library with no arguments displays help information:

::

$ java -jar dxldatabusclient-2.4.9.jar
$ java -jar dxldatabusclient-2.4.10.jar

ERROR: There are not options
Option (* = required) Description
--------------------- -----------
* --brokers <String: broker list> Comma-separated broker list: Example:
broker1:port1,broker2:port2,...,
brokerN:portN
--cg <String: cg> The consumer group name.
--config [String: config] The producer/consumer configuration
list: Example: linger.ms=1000,batch.
size=100000,compression.type=lz4
Option (* = required) Description
--------------------- -----------
* --brokers <String: broker list> Comma-separated broker list: Example:
broker1:port1,broker2:port2,...,
brokerN:portN
--cg <String: cg> The consumer group name.
--config [String: config] The producer/consumer configuration
list: Example: linger.ms=1000,batch.
size=100000,compression.type=lz4
--consume-records <Integer: consume- Number of expected records to finish
records> the command line. (default: 1)
--consume-timeout <Integer: consume- Max time the command line waits for
timeout> finishing a consumer operation.
Optional parameter, if absent, it
defaults to 15000 ms. (default: 15000)
--from-topic <String: from-topic> Comma-separated topic name list to
consume. Example: topic1,topic2,...,
topicN
--headers [String: headers] The producer headers: (default: )
--msg <String: message> message to be produced
consume. Example: topic1,topic2,...,
topicN
--headers [String: headers] The producer headers: (default: )
--msg <String: message> message to be produced
--operation <String: operation> Operations: produce | consume
--partition [String: partition] The partition number: (default: )
--sharding-key [String: sharding-key] Sharding key (default: )
--tenant-group [String: tenant-group] Tenant Group (default: )
--partition [String: partition] The partition number: (default: )
--sharding-key [String: sharding-key] Sharding key (default: )
--tenant-group [String: tenant-group] Tenant Group (default: )
--to-topic <String: to-topic> Topic name to produce

*Note:* ``<String: FIELD>`` are mandatory placeholders which you should
Expand All @@ -50,7 +50,7 @@ few CLI operations. Operations arguments are placed after

::

$ java -jar dxldatabusclient-2.4.9.jar --operation <OPERATION_ARGUMENT> ...
$ java -jar dxldatabusclient-2.4.10.jar --operation <OPERATION_ARGUMENT> ...

Operation Arguments
^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -123,12 +123,12 @@ example

::

$ java -jar dxldatabusclient-2.4.9.jar \
$ java -jar dxldatabusclient-2.4.10.jar \
--operation produce \
--to-topic <TOPIC_NAME> \
--brokers <0.0.0.0>:<PORT> \
--msg <MESSAGE> \
--tenant-group <TENANT-GROUP> \
--tenant-group <TENANT-GROUP> \
--sharding-key <KEY> \
--partition <PARTITION-NUMBER> \

Expand Down Expand Up @@ -230,15 +230,15 @@ example

::

java -jar dxldatabusclient-2.4.9.jar \
java -jar dxldatabusclient-2.4.10.jar \
--operation consume \
--from-topic <TOPIC_1,TOPIC_2,...,TOPIC_N> \
--brokers <BROKER_1_IP:BROKER_1_PORT,BROKER_2_PORT:BROKER_2_PORT,...> \
--consume-timeout <CONSUME-TIMEOUT-TO-FINISH-CLI> \
--consume-records <CONSUME-RECORDS-NUMBER-TO-FINISH-CLI> \
--tenant-group <TENANT-GROUP-NAME> \
--cg <CONSUMER-GROUP>
--config enable.auto.commit=true
--config enable.auto.commit=true

The response example illustrates that two records are returned.

Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ Maven:
<dependency>
<groupId>com.opendxl</groupId>
<artifactId>dxldatabusclient</artifactId>
<version>2.4.9</version>
<version>2.4.10</version>
</dependency>
or Gradle:

.. code:: groovy
compile 'com.opendxl:dxldatabusclient:2.4.9'
compile 'com.opendxl:dxldatabusclient:2.4.10'
API Documentation
-----------------
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version=2.4.9
version=2.4.10

0 comments on commit 3740a02

Please sign in to comment.