Package org.apache.kafka.clients.admin.internals

Class AdminApiHandler.Batched<K,V>

java.lang.Object

org.apache.kafka.clients.admin.internals.AdminApiHandler.Batched<K,V>

All Implemented Interfaces:

AdminApiHandler<K,V>

Direct Known Subclasses:

AbortTransactionHandler, AlterConsumerGroupOffsetsHandler, DeleteConsumerGroupOffsetsHandler, DeleteConsumerGroupsHandler, DeleteRecordsHandler, DescribeConsumerGroupsHandler, DescribeProducersHandler, DescribeTransactionsHandler, ListOffsetsHandler, ListTransactionsHandler, RemoveMembersFromConsumerGroupHandler

Enclosing interface:

AdminApiHandler<K,V>

public abstract static class AdminApiHandler.Batched<K,V>
extends Object
implements AdminApiHandler<K,V>

An AdminApiHandler that will group multiple keys into a single request when possible. Keys will be grouped together whenever they target the same broker. This type of handler should be used when interacting with broker APIs that can act on multiple keys at once, such as describing or listing transactions.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.kafka.clients.admin.internals.AdminApiHandler

AdminApiHandler.ApiResult<K,V>, AdminApiHandler.Batched<K,V>, AdminApiHandler.RequestAndKeys<K>, AdminApiHandler.Unbatched<K,V>

Constructor Summary

Constructors

Constructor	Description
Batched()

Method Summary

Modifier and Type	Method	Description
final Collection<AdminApiHandler.RequestAndKeys<K>>	buildRequest(int brokerId, Set<K> keys)	Build the requests necessary for the given keys.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.kafka.clients.admin.internals.AdminApiHandler

apiName, handleResponse, handleUnsupportedVersionException, lookupStrategy

Constructor Details

Batched

public Batched()

Method Details

buildRequest

public final Collection<AdminApiHandler.RequestAndKeys<K>> buildRequest(int brokerId,
 Set<K> keys)

Description copied from interface: AdminApiHandler

Build the requests necessary for the given keys. The set of keys is derived by AdminApiDriver during the lookup stage as the set of keys which all map to the same destination broker. Handlers can choose to issue a single request for all of the provided keys (see AdminApiHandler.Batched, issue one request per key (see AdminApiHandler.Unbatched, or implement their own custom grouping logic if necessary.

Specified by:

buildRequest in interface AdminApiHandler<K,V>

Parameters:

brokerId - the target brokerId for the request

keys - the set of keys that should be handled by this request

Returns:

a collection of AdminApiHandler.RequestAndKeys for the requests containing the given keys