(kafka) branch trunk updated: KAFKA-19005 improve the documentation of DescribeTopicsOptions#partitionSizeLimitPerResponse (#19268)

[chia7712]

This is an automated email from the ASF dual-hosted git repository.

chia7712 pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/trunk by this push:
     new c771116b89b KAFKA-19005 improve the documentation of 
DescribeTopicsOptions#partitionSizeLimitPerResponse (#19268)
c771116b89b is described below

commit c771116b89bbd9916b4315140a6c5c087c16e354
Author: Nick Guo <lansg0...@gmail.com>
AuthorDate: Sat Mar 29 03:21:10 2025 +0800

    KAFKA-19005 improve the documentation of 
DescribeTopicsOptions#partitionSizeLimitPerResponse (#19268)
    
    jira: https://issues.apache.org/jira/browse/KAFKA-19005
    
    This PR includes following changes:
    1. refine the format
    2. highligh that it is supported by topic names
    
    <img width="857" alt="999"
    
src="https://github.com/user-attachments/assets/6eec9e2f-b839-430c-b111-2be3a8538593";
    />
    
    Reviewers: Chia-Ping Tsai <chia7...@gmail.com>
---
 .../apache/kafka/clients/admin/DescribeTopicsOptions.java | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git 
a/clients/src/main/java/org/apache/kafka/clients/admin/DescribeTopicsOptions.java
 
b/clients/src/main/java/org/apache/kafka/clients/admin/DescribeTopicsOptions.java
index 831e4297fef..189c8c17531 100644
--- 
a/clients/src/main/java/org/apache/kafka/clients/admin/DescribeTopicsOptions.java
+++ 
b/clients/src/main/java/org/apache/kafka/clients/admin/DescribeTopicsOptions.java
@@ -43,8 +43,19 @@ public class DescribeTopicsOptions extends 
AbstractOptions<DescribeTopicsOptions
         return this;
     }
 
-    // Note that, partitionSizeLimitPerResponse will not be effective if it is 
larger than the config
-    // max.request.partition.size.limit on the server side.
+    /**
+     * Sets the maximum number of partitions to be returned in a single 
response.
+     * <p>
+     * <strong>This option:</strong>
+     * <ul>
+     *   <li>Is only effective when using topic names (not topic IDs).</li>
+     *   <li>Will not be effective if it is larger than the server-side 
configuration
+     *       {@code max.request.partition.size.limit}.
+     *   </li>
+     * </ul>
+     * 
+     * @param partitionSizeLimitPerResponse the maximum number of partitions 
per response
+     */
     public DescribeTopicsOptions partitionSizeLimitPerResponse(int 
partitionSizeLimitPerResponse) {
         this.partitionSizeLimitPerResponse = partitionSizeLimitPerResponse;
         return this;