For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

Type Alias: ClusterRebalancePartition

type ClusterRebalancePartition = object;

One partition's leadership/balance status - its current leader, its desired leader, and whether a rebalance is currently moving it.

Properties​

currentLeader​

currentLeader: string | null;

The broker ID currently leading this partition, or absent if it has no leader.


desiredLeader​

desiredLeader: string;

The broker ID the current configuration wants to lead this partition.


partitionId​

partitionId: number;

The unique ID of this partition, within its physical tenant.


physicalTenantId​

physicalTenantId: string;

The partition group this partition belongs to. Partition IDs are unique only within a group, so this is needed to identify the partition.


state​

state: "TRANSFERRING" | "UNBALANCED" | "BALANCED";

Whether this partition is being actively transferred, unbalanced, or balanced.