[GitHub] [kafka] hachikuji commented on a diff in pull request #12206: KAFKA-13888: Addition of Information in DescribeQuorumResponse about Voter Lag

[GitBox]

hachikuji commented on code in PR #12206:
URL: https://github.com/apache/kafka/pull/12206#discussion_r881020616


##########
clients/src/main/java/org/apache/kafka/clients/admin/Admin.java:
##########
@@ -1382,6 +1382,23 @@ default DescribeFeaturesResult describeFeatures() {
         return describeFeatures(new DescribeFeaturesOptions());
     }
 
+    /**
+     * Describe the state of the raft quorum
+     * <p>
+     * The following exceptions can be anticipated when calling {@code get()} 
on the futures obtained from
+     * the returned {@code DescribeQuorumResult}:
+     * <ul>
+     *   <li>{@link 
org.apache.kafka.common.errors.ClusterAuthorizationException}
+     *   If the authenticated user didn't have {@code DESCRIBE} access to the 
cluster.</li>
+     *   <li>{@link org.apache.kafka.common.errors.TimeoutException}
+     *   If the request timed out before the controller could list the cluster 
links.</li>
+     * </ul>
+     *
+     * @param options The options to use when describing the quorum.
+     * @return The DescribeQuorumResult.
+     */
+    DescribeQuorumResult describeQuorum(DescribeQuorumOptions options);

Review Comment:
   By the way, usually these APIs have a default option which leaves out the 
`XOptions` class. For example, see `describeFeatures()` above?
   
   Also nit: can we not split up the `describeFeatures` APIs?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: jira-unsubscr...@kafka.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org