Package org.apache.kafka.clients.admin

Class DescribeTopicsOptions

java.lang.Object

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

org.apache.kafka.clients.admin.DescribeTopicsOptions

public class DescribeTopicsOptions
extends AbstractOptions<DescribeTopicsOptions>

Options for Admin.describeTopics(Collection).

Constructor Summary

Constructors

Constructor	Description
DescribeTopicsOptions()

Method Summary

Modifier and Type	Method	Description
boolean	includeAuthorizedOperations()
DescribeTopicsOptions	includeAuthorizedOperations(boolean includeAuthorizedOperations)
int	partitionSizeLimitPerResponse()
DescribeTopicsOptions	partitionSizeLimitPerResponse(int partitionSizeLimitPerResponse)	Sets the maximum number of partitions to be returned in a single response.
DescribeTopicsOptions	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

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DescribeTopicsOptions

public DescribeTopicsOptions()

Method Details

timeoutMs

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

includeAuthorizedOperations

public DescribeTopicsOptions includeAuthorizedOperations(boolean includeAuthorizedOperations)

partitionSizeLimitPerResponse

public DescribeTopicsOptions partitionSizeLimitPerResponse(int partitionSizeLimitPerResponse)

Sets the maximum number of partitions to be returned in a single response.

This option:

• Is only effective when using topic names (not topic IDs).
• Will not be effective if it is larger than the server-side configuration max.request.partition.size.limit.

Parameters:

partitionSizeLimitPerResponse - the maximum number of partitions per response

includeAuthorizedOperations

public boolean includeAuthorizedOperations()

partitionSizeLimitPerResponse

public int partitionSizeLimitPerResponse()