org.apache.kafka.clients.admin

Class ElectPreferredLeadersResult

java.lang.Object

org.apache.kafka.clients.admin.ElectPreferredLeadersResult

@InterfaceStability.Evolving
public class ElectPreferredLeadersResult
extends Object

The result of AdminClient.electPreferredLeaders(Collection, ElectPreferredLeadersOptions) The API of this class is evolving, see AdminClient for details.

Method Summary

Modifier and Type	Method and Description
KafkaFuture<Void>	all() Return a future which succeeds if all the topic elections succeed.
KafkaFuture<Void>	partitionResult(TopicPartition partition) Get the result of the election for the given partition.
KafkaFuture<Set<TopicPartition>>	partitions() Get a future for the topic partitions for which a leader election was attempted.

Methods inherited from class java.lang.Object

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

Method Detail

partitionResult

public KafkaFuture<Void> partitionResult(TopicPartition partition)

Get the result of the election for the given partition. If there was not an election triggered for the given partition, the returned future will complete with an error.

partitions

public KafkaFuture<Set<TopicPartition>> partitions()

Get a future for the topic partitions for which a leader election was attempted. A partition will be present in this result if an election was attempted even if the election was not successful.

This method is provided to discover the partitions attempted when AdminClient.electPreferredLeaders(Collection) is called with a null partitions argument.

all

public KafkaFuture<Void> all()

Return a future which succeeds if all the topic elections succeed.