Package org.apache.kafka.clients.admin

Enum Class BrokerReplicaExclusionStatus

java.lang.Object

java.lang.Enum<BrokerReplicaExclusionStatus>

org.apache.kafka.clients.admin.BrokerReplicaExclusionStatus

All Implemented Interfaces:

Serializable, Comparable<BrokerReplicaExclusionStatus>, Constable

public enum BrokerReplicaExclusionStatus
extends Enum<BrokerReplicaExclusionStatus>

Denotes the status of the broker replica exclusion sub task of a given Confluent Balancer operation. The status applies to all the broker replica exclusions. See #

invalid reference

ConfluentAdmin#alterBrokerReplicaExclusions()

for more information about broker replica exclusion.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELED	When the exclusion operation is canceled prior to initiation due to external influence.
COMPLETED	When the exclusion has been removed successfully.
ERROR	When broker replica exclusion (either setting or removing the exclusion) was started but did not complete successfully.
EXCLUDED	When the broker has been excluded from the cluster.
IN_PROGRESS	When the broker is being excluded from having replicas on it.
PENDING	When the broker is yet to be excluded from having replicas on it.
REMOVING	When the exclusion is in the process of being removed.
UNKNOWN	Kept for future-compatibility reasons - clients will fall-back to this status when they receive an unrecognized one

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PENDING

public static final BrokerReplicaExclusionStatus PENDING

When the broker is yet to be excluded from having replicas on it.

IN_PROGRESS

public static final BrokerReplicaExclusionStatus IN_PROGRESS

When the broker is being excluded from having replicas on it.

EXCLUDED

public static final BrokerReplicaExclusionStatus EXCLUDED

When the broker has been excluded from the cluster.

REMOVING

public static final BrokerReplicaExclusionStatus REMOVING

When the exclusion is in the process of being removed.

ERROR

public static final BrokerReplicaExclusionStatus ERROR

When broker replica exclusion (either setting or removing the exclusion) was started but did not complete successfully. Users may need to check the exclusion status of brokers and manually remove exclusions.

CANCELED

public static final BrokerReplicaExclusionStatus CANCELED

When the exclusion operation is canceled prior to initiation due to external influence.

COMPLETED

public static final BrokerReplicaExclusionStatus COMPLETED

When the exclusion has been removed successfully.

UNKNOWN

public static final BrokerReplicaExclusionStatus UNKNOWN

Kept for future-compatibility reasons - clients will fall-back to this status when they receive an unrecognized one

Method Details

values

public static BrokerReplicaExclusionStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static BrokerReplicaExclusionStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toEnum

public static BrokerReplicaExclusionStatus toEnum(String name)