chia7712 commented on a change in pull request #9459:
URL: https://github.com/apache/kafka/pull/9459#discussion_r508960771
##########
File path: clients/src/main/java/org/apache/kafka/clients/admin/Admin.java
##########
@@ -45,15 +45,76 @@
/**
* The administrative client for Kafka, which supports managing and inspecting
topics, brokers, configurations and ACLs.
* <p>
+ * Instances returned from the {@code create} methods of this interface are
guaranteed to be thread safe.
+ * <p>
+ * The operations exposed by Admin follow a consistent pattern:
+ * <ul>
+ * <li>Admin instances should be created using {@link
Admin#create(Properties)} or {@link Admin#create(Map)}</li>
+ * <li>Each operation typically has two overloaded methods, one which uses
a default set of options and an
+ * overloaded method where the last parameter is an explicit options
object.
+ * <li>The operation method's first parameter is a {@code Collection} of
items to perform
+ * the operation on. Batching multiple requests into a single call is more
efficient and should be
+ * preferred over multiple calls to the same method.
+ * <li>The operation methods execute asynchronously.
+ * <li>Each {@code xxx} operation method returns an {@code XxxResult}
class with methods which expose
+ * {@link org.apache.kafka.common.KafkaFuture} for accessing the result(s)
of the operation.
+ * <li>Typically an {@code all()} method is provided for getting the
overall success/failure of the batch and a
+ * {@code values()} method provided access to each item in a request batch.
+ * Other methods may also be provided.
+ * <li>For synchronous behaviour use {@link
org.apache.kafka.common.KafkaFuture#get}
Review comment:
```{@link org.apache.kafka.common.KafkaFuture#get}``` => ```{@link
org.apache.kafka.common.KafkaFuture#get()}```
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
