Package org.apache.kafka.clients.admin

Class DescribeClusterOptions

java.lang.Object

org.apache.kafka.clients.admin.AbstractOptions<DescribeClusterOptions>

org.apache.kafka.clients.admin.DescribeClusterOptions

@Evolving
public class DescribeClusterOptions
extends AbstractOptions<DescribeClusterOptions>

Options for Admin.describeCluster(). 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
DescribeClusterOptions()

Method Summary

Modifier and Type	Method	Description
boolean	includeAuthorizedOperations()	Specify if authorized operations should be included in the response.
DescribeClusterOptions	includeAuthorizedOperations(boolean includeAuthorizedOperations)
DescribeClusterOptions	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 Details

DescribeClusterOptions

public DescribeClusterOptions()

Method Details

timeoutMs

public DescribeClusterOptions 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<DescribeClusterOptions>

includeAuthorizedOperations

public DescribeClusterOptions includeAuthorizedOperations(boolean includeAuthorizedOperations)

includeAuthorizedOperations

public boolean includeAuthorizedOperations()

Specify if authorized operations should be included in the response. Note that some older brokers cannot not supply this information even if it is requested.