kafka/docs
Ken Huang ebae768bd8
KAFKA-18193 Refactor Kafka Streams CloseOptions to Fluent API Style (#19955)
In Kafka Streams, configuration classes typically follow a fluent API
pattern to ensure a consistent and intuitive developer experience.
However, the current implementation of
`org.apache.kafka.streams.KafkaStreams$CloseOptions` deviates from this
convention by exposing a public constructor, breaking the uniformity
expected across the API.

To address this inconsistency, we propose introducing a new
`CloseOptions` class that adheres to the fluent API style, replacing the
existing implementation. The new class will retain the existing
`timeout(Duration)` and `leaveGroup(boolean)` methods but will enforce
fluent instantiation and configuration. Given the design shift, we will
not maintain backward compatibility with the current class.

This change aligns with the goal of standardizing configuration objects
across Kafka Streams, offering developers a more cohesive and
predictable API.

Reviewers: Bill Bejeck<bbejeck@apache.org>
2025-10-07 08:50:18 -04:00
..
documentation KAFKA-18074: Add kafka client compatibility matrix (#18091) 2025-03-11 18:38:37 -07:00
images KAFKA-18111: Add Kafka Logo to README (#18452) 2025-01-08 17:17:31 -08:00
js MINOR: Bump trunk to 4.2.0-SNAPSHOT (#19944) 2025-06-11 09:24:57 +02:00
streams KAFKA-19748: Add a note in docs about memory leak in Kafka Streams 4.1.0 (#20639) 2025-10-06 11:59:51 -07:00
README.md KAFKA-16467: add docs README (#15664) 2024-04-30 10:26:35 +08:00
api.html KAFKA-19353: Upgrade note and initial docs for KIP-932 (#19863) 2025-06-03 13:23:11 +01:00
compatibility-summary.html KAFKA-18074: Add kafka client compatibility matrix (#18091) 2025-03-11 18:38:37 -07:00
configuration.html KAFKA-19112 Unifying LIST-Type Configuration Validation and Default Values (#20334) 2025-09-06 01:25:55 +08:00
connect.html MINOR: Tidy up the Connect docs (#20531) 2025-09-25 09:39:37 +02:00
design.html KAFKA-19283: Update transaction exception handling documentation (#19931) 2025-06-09 17:07:29 -07:00
docker.html MINOR: Refresh of the docs (#16375) 2024-06-18 17:15:47 +02:00
documentation.html KAFKA-18074: Add kafka client compatibility matrix (#18091) 2025-03-11 18:38:37 -07:00
ecosystem.html MINOR: Use immutable KIP link (#19153) 2025-03-09 23:42:33 +08:00
implementation.html KAFKA-19644 Enhance the documentation for producer headers and integration tests (#20524) 2025-09-20 11:46:19 +08:00
introduction.html MINOR: Use immutable KIP link (#19153) 2025-03-09 23:42:33 +08:00
ops.html KAFKA-19721: Update streams documentation with KIP-1147 changes (#20606) 2025-10-01 20:17:47 +01:00
protocol.html MINOR: Use immutable KIP link (#19153) 2025-03-09 23:42:33 +08:00
quickstart.html KAFKA-18229: Move configs out of "kraft" directory (#18389) 2025-01-22 15:47:57 +01:00
security.html KAFKA-19623: Implement KIP-1147 for console producer/consumer/share-consumer. (#20479) 2025-09-17 15:28:20 +01:00
toc.html MINOR: add missing section to TOC (#20305) 2025-08-05 14:27:09 -07:00
upgrade.html KAFKA-18193 Refactor Kafka Streams CloseOptions to Fluent API Style (#19955) 2025-10-07 08:50:18 -04:00
uses.html MINOR: Various fixes in the docs (#14914) 2023-12-04 22:06:49 +01:00
zk2kraft-summary.html MINOR: Adjust ToC of zk2kraft and fix wrong section number of docker (#19146) 2025-03-09 08:55:50 +08:00

README.md

Docs

The documentation needs to run with kafka-site. Please check the README in the kafka-site repository to preview documentation locally.