DescribeConfigsOptions (kafka 2.8.1 API)

java.lang.Object
- org.apache.kafka.clients.admin.AbstractOptions<DescribeConfigsOptions>
- - org.apache.kafka.clients.admin.DescribeConfigsOptions

```
@Evolving
public class DescribeConfigsOptions
extends AbstractOptions<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

Constructors
Constructor Description

DescribeConfigsOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`includeDocumentation()`	Return true if config documentation should be returned in the response.
`DescribeConfigsOptions`	`includeDocumentation(boolean includeDocumentation)`	Set to true if config documentation should be returned in the response.
`boolean`	`includeSynonyms()`	Return true if synonym configs should be returned in the response.
`DescribeConfigsOptions`	`includeSynonyms(boolean includeSynonyms)`	Set to true if synonym configs should be returned in the response.
`DescribeConfigsOptions`	`timeoutMs(Integer timeoutMs)`	Set the timeout in milliseconds for this operation or `null` if the default api timeout for the AdminClient should be used.

Methods inherited from class org.apache.kafka.clients.admin.AbstractOptions
timeoutMs

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DescribeConfigsOptions
```
public DescribeConfigsOptions()
```
- Method Detail
  - timeoutMs
```
public DescribeConfigsOptions timeoutMs(Integer timeoutMs)
```
    Set the timeout in milliseconds for this operation or null if the default api timeout for the AdminClient should be used.
    
    Overrides:
    
    timeoutMs in class AbstractOptions<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
```
public DescribeConfigsOptions includeSynonyms(boolean includeSynonyms)
```
    Set to true if synonym configs should be returned in the response.
  - includeDocumentation
```
public DescribeConfigsOptions includeDocumentation(boolean includeDocumentation)
```
    Set to true if config documentation should be returned in the response.