kafka.assignor

Interface TopicReplicaAssignor

public interface TopicReplicaAssignor

A interface for computing a replica assignment for a given topic. A new TopicReplicaAssignor instance is built on each CreateTopicsRequest and CreatePartitionsRequest. Said instance is used for assignments for that request exclusively.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TopicReplicaAssignor.NewPartitions

Method Summary

Modifier and Type	Method and Description
Optional<List<List<Integer>>>	computeAssignmentForExistingTopic(TopicReplicaAssignor.NewPartitions partitions, Optional<TopicPlacement> topicPlacementOpt, Set<Integer> excludedBrokerIds) Computes the replica assignment for an existing topic that is about to have new partitions created on it (CreatePartitions request).
Optional<List<List<Integer>>>	computeAssignmentForNewTopic(TopicReplicaAssignor.NewPartitions partitions, Optional<TopicPlacement> topicPlacementOpt, Set<Integer> excludedBrokerIds) Computes the replica assignment for a topic that's about to be created (CreateTopics request).

Method Detail

computeAssignmentForNewTopic

Optional<List<List<Integer>>> computeAssignmentForNewTopic(TopicReplicaAssignor.NewPartitions partitions,
                                                           Optional<TopicPlacement> topicPlacementOpt,
                                                           Set<Integer> excludedBrokerIds)
                                                    throws org.apache.kafka.common.errors.ApiException

Computes the replica assignment for a topic that's about to be created (CreateTopics request).

Parameters:

partitions - - an pre-validated TopicReplicaAssignor.NewPartitions argument. Implementations do not need to re-validate this parameter (e.g non-negative values, consistency in number of partitions).

topicPlacementOpt - - an optional denoting topic placement constraints for this topic.

excludedBrokerIds - - a list of broker IDs that are excluded from replica placement. No new replicas should be placed on these brokers.

Returns:

an optional list of replica assignments for each new partition in order. if empty, the assignor could not come up with an assignment and delegates this to the default assignor.

Throws:

org.apache.kafka.common.errors.ApiException - - in case anything is wrong with the requested TopicReplicaAssignor.NewPartitions (e.g invalid number of partitions)

computeAssignmentForExistingTopic

Optional<List<List<Integer>>> computeAssignmentForExistingTopic(TopicReplicaAssignor.NewPartitions partitions,
                                                                Optional<TopicPlacement> topicPlacementOpt,
                                                                Set<Integer> excludedBrokerIds)
                                                         throws org.apache.kafka.common.errors.ApiException

Computes the replica assignment for an existing topic that is about to have new partitions created on it (CreatePartitions request).

Parameters:

partitions - - an pre-validated TopicReplicaAssignor.NewPartitions argument. Implementations do not need to re-validate this parameter (e.g non-negative values, consistency in number of partitions)

topicPlacementOpt - - an optional denoting topic placement constraints for this topic.

excludedBrokerIds - - a list of broker IDs that are excluded from replica placement. No new replicas should be placed on these brokers.

Returns:

an optional list of replica assignments for each new partition in order. if empty, the assignor could not come up with an assignment and delegates this to the default assignor.

Throws:

org.apache.kafka.common.errors.ApiException - - in case anything is wrong with the requested TopicReplicaAssignor.NewPartitions (e.g invalid number of partitions)