kafka-common-requests-ElectPreferredLeadersRequest.adoc

ElectPreferredLeadersRequest

ElectPreferredLeadersRequest is a message request that is sent out from KafkaAdminClient when requested to elect preferred partition leaders (e.g. using kafka-leader-election.sh shell script) to the controller broker.

ElectPreferredLeadersRequest uses ElectPreferredLeaders API key and the following properties:

• ElectPreferredLeadersRequestData

• Version

ElectPreferredLeadersRequest is created when:

• AbstractRequest is requested to parse a request (with the ElectPreferredLeaders API key)

• ElectPreferredLeadersRequest is requested to parse a byte buffer

• ElectPreferredLeadersRequest.Builder is requested to build a ElectPreferredLeadersRequest

ElectPreferredLeadersRequestData

ElectPreferredLeadersRequestData is an API message with the following properties:

• Topic partitions (a topic and partition IDs) to elect the preferred leader of

• Time (ms) to wait for the election to complete

ElectPreferredLeadersRequest.Builder Factory Object

ElectPreferredLeadersRequest.Builder is a request builder to build a ElectPreferredLeadersRequest.

ElectPreferredLeadersRequest build(short version)

toRequestData Object Method

ElectPreferredLeadersRequestData toRequestData(
  Collection<TopicPartition> partitions,
  int timeoutMs)

toRequestData…​FIXME

Note	toRequestData is used when…​FIXME

fromResponseData Object Method

Map<TopicPartition, ApiError> fromResponseData(
  ElectPreferredLeadersResponseData data)

fromResponseData…​FIXME

Note	fromResponseData is used when…​FIXME

Creating ElectPreferredLeadersRequest from Byte Buffer — parse Object Method

ElectPreferredLeadersRequest parse(
  ByteBuffer buffer,
  short version)

parse…​FIXME

Note	parse is used when…​FIXME