org.apache.kafka.clients.admin

Enum BrokerComponent

java.lang.Object

java.lang.Enum<BrokerComponent>

org.apache.kafka.clients.admin.BrokerComponent

All Implemented Interfaces:

Serializable, Comparable<BrokerComponent>

public enum BrokerComponent
extends Enum<BrokerComponent>

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXTERNAL_CONNECTIVITY_STARTUP
NETWORK
STORAGE
UNKNOWN
UNSPECIFIED

Method Summary

Modifier and Type	Method and Description
static BrokerComponent	forId(byte id)
static BrokerComponent	forString(String str)
byte	id()
boolean	isDowngradeAllowed() Returns whether downgrading from this component to UNSPECIFIED is supported.
boolean	isValid(short version)
BrokerComponent	maybeDowngrade(short version) Given a Broker Health API version, checks if this component code is invalid and if it is eligible for downgrade, convert to BrokerComponent.UNSPECIFIED.
int	minSupportedVersion() Returns the minimum Broker Health API version at which this component code is supported.
static BrokerComponent	valueOf(String name) Returns the enum constant of this type with the specified name.
static BrokerComponent[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final BrokerComponent UNKNOWN

UNSPECIFIED

public static final BrokerComponent UNSPECIFIED

STORAGE

public static final BrokerComponent STORAGE

NETWORK

public static final BrokerComponent NETWORK

EXTERNAL_CONNECTIVITY_STARTUP

public static final BrokerComponent EXTERNAL_CONNECTIVITY_STARTUP

Method Detail

values

public static BrokerComponent[] 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 (BrokerComponent c : BrokerComponent.values())
    System.out.println(c);

Returns:

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

valueOf

public static BrokerComponent 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

id

public byte id()

isDowngradeAllowed

public boolean isDowngradeAllowed()

Returns whether downgrading from this component to UNSPECIFIED is supported.

minSupportedVersion

public int minSupportedVersion()

Returns the minimum Broker Health API version at which this component code is supported.

maybeDowngrade

public BrokerComponent maybeDowngrade(short version)

Given a Broker Health API version, checks if this component code is invalid and if it is eligible for downgrade, convert to BrokerComponent.UNSPECIFIED.

isValid

public boolean isValid(short version)

forId

public static BrokerComponent forId(byte id)

forString

public static BrokerComponent forString(String str)