docs: Options overview JavaDoc

confluentinc · Dec 7, 2022 · 33210db · 33210db
1 parent 78d66c0
commit 33210db
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/...el-consumer-core/src/main/java/io/confluent/parallelconsumer/ParallelConsumerOptions.java b/...el-consumer-core/src/main/java/io/confluent/parallelconsumer/ParallelConsumerOptions.java
@@ -24,6 +24,16 @@
 
 /**
  * The options for the {@link AbstractParallelEoSStreamProcessor} system.
+ * <p>
+ * The important options to look at are:
+ * <p>
+ * {@link #ordering}, {@link #maxConcurrency} and {@link #batchSize}.
+ * <p>
+ * If you want to go deeper, look at {@link #defaultMessageRetryDelay}, {@link #retryDelayProvider} and
+ * {@link #commitMode}.
+ * <p>
+ * Note: The only required option is the {@link #consumer} ({@link #producer} is only needed if you use the Produce
+ * flows). All other options have sensible defaults.
  *
  * @author Antony Stubbs
  * @see #builder()