Type Alias ClusterRebalancePartition

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

type ClusterRebalancePartition = {
    currentLeader: string | null;
    desiredLeader: string;
    partitionId: number;
    physicalTenantId: string;
    state: "TRANSFERRING" | "UNBALANCED" | "BALANCED";
}

Properties

currentLeader: string | null

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

desiredLeader: string

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

partitionId: number

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

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: "TRANSFERRING" | "UNBALANCED" | "BALANCED"

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