org.apache.kafka.clients.admin

Enum BalancerStatus

java.lang.Object

java.lang.Enum<BalancerStatus>

org.apache.kafka.clients.admin.BalancerStatus

All Implemented Interfaces:

Serializable, Comparable<BalancerStatus>

public enum BalancerStatus
extends Enum<BalancerStatus>

The status of the Confluent Balancer component.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOTSTRAPPING The initial state of balancer component during which a request for balancer is received from the controller.
DISABLED The state at which the balancer component is disabled.
ENABLED The state at which is cruise control is running.
ERROR The state at which the balancer component is not able to start because JBOD is enabled or metrics collection is disabled, some other misconfiguration or cruise control hit some error.
FAILOVER The terminal state at which the balancer component is shutting down, this can occur due to controller failover.
LOAD_FAILURE Status when SBC class cannot be loaded (maybe because of missing classes or classpath issues)
STARTING The state at which the cruise control instance is being initialized.
UNKNOWN Clients will fall back to this status when they receive an unrecognized status value.

Method Summary

Modifier and Type	Method and Description
static BalancerStatus	toEnum(String name)
static BalancerStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static BalancerStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BOOTSTRAPPING

public static final BalancerStatus BOOTSTRAPPING

The initial state of balancer component during which a request for balancer is received from the controller.

STARTING

public static final BalancerStatus STARTING

The state at which the cruise control instance is being initialized.

ENABLED

public static final BalancerStatus ENABLED

The state at which is cruise control is running.

DISABLED

public static final BalancerStatus DISABLED

The state at which the balancer component is disabled.

LOAD_FAILURE

public static final BalancerStatus LOAD_FAILURE

Status when SBC class cannot be loaded (maybe because of missing classes or classpath issues)

ERROR

public static final BalancerStatus ERROR

The state at which the balancer component is not able to start because JBOD is enabled or metrics collection is disabled, some other misconfiguration or cruise control hit some error.

FAILOVER

public static final BalancerStatus FAILOVER

The terminal state at which the balancer component is shutting down, this can occur due to controller failover.

UNKNOWN

public static final BalancerStatus UNKNOWN

Clients will fall back to this status when they receive an unrecognized status value.

Since:

7.0.0

Method Detail

values

public static BalancerStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BalancerStatus c : BalancerStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BalancerStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toEnum

public static BalancerStatus toEnum(String name)