org.apache.kafka.clients.admin

Class BalancerStatusDescription

java.lang.Object

org.apache.kafka.clients.admin.BalancerStatusDescription

public class BalancerStatusDescription
extends Object

A description of the balancer status which is fetched via ConfluentAdmin.describeBalancerStatus(DescribeBalancerStatusOptions). The status of the balancer is tracked by a status field: #balancerStatus(). * IDs of the brokers where Confluent Balancer is running is stored in field #brokerIds(). In addition to the status field, the #balancerOperationError() gives context about the status of the balancer, e.g. why the balancer is in an error state etc.

Constructor Summary

Constructors

Constructor and Description
BalancerStatusDescription(BalancerStatus balancerStatus, Collection<Integer> brokerIds, BalancerOperationError balancerOperationError)

Method Summary

Modifier and Type	Method and Description
Optional<BalancerOperationError>	balancerOperationError() An optional error that gives context as to why the balancer is in the given state.
BalancerStatus	balancerStatus() The current status of the Confluent Balancer component.
Collection<Integer>	brokerIds() IDs of the brokers where Confluent Balancer component is running.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BalancerStatusDescription

public BalancerStatusDescription(BalancerStatus balancerStatus,
                                 Collection<Integer> brokerIds,
                                 BalancerOperationError balancerOperationError)

Method Detail

balancerStatus

public BalancerStatus balancerStatus()

The current status of the Confluent Balancer component.

See Also:

BalancerStatus

brokerIds

public Collection<Integer> brokerIds()

IDs of the brokers where Confluent Balancer component is running.

Returns:

a set of unique broker ids

balancerOperationError

public Optional<BalancerOperationError> balancerOperationError()

An optional error that gives context as to why the balancer is in the given state.

toString

public String toString()

Overrides:

toString in class Object