Package org.apache.kafka.clients.admin
Class DescribeConfigsOptions
java.lang.Object
org.apache.kafka.clients.admin.AbstractOptions<DescribeConfigsOptions>
org.apache.kafka.clients.admin.DescribeConfigsOptions
Options for
Admin.describeConfigs(Collection)
.
The API of this class is evolving, see Admin
for details.-
Field Summary
Fields inherited from class org.apache.kafka.clients.admin.AbstractOptions
timeoutMs
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Return true if config documentation should be returned in the response.includeDocumentation
(boolean includeDocumentation) Set to true if config documentation should be returned in the response.boolean
Return true if synonym configs should be returned in the response.includeSynonyms
(boolean includeSynonyms) Set to true if synonym configs should be returned in the response.Set the timeout in milliseconds for this operation ornull
if the default api timeout for the AdminClient should be used.Methods inherited from class org.apache.kafka.clients.admin.AbstractOptions
timeoutMs
-
Constructor Details
-
DescribeConfigsOptions
public DescribeConfigsOptions()
-
-
Method Details
-
timeoutMs
Set the timeout in milliseconds for this operation ornull
if the default api timeout for the AdminClient should be used.- Overrides:
timeoutMs
in classAbstractOptions<DescribeConfigsOptions>
-
includeSynonyms
public boolean includeSynonyms()Return true if synonym configs should be returned in the response. -
includeDocumentation
public boolean includeDocumentation()Return true if config documentation should be returned in the response. -
includeSynonyms
Set to true if synonym configs should be returned in the response. -
includeDocumentation
Set to true if config documentation should be returned in the response.
-