org.apache.kafka.clients.admin

Enum BrokerShutdownStatus

java.lang.Object

java.lang.Enum<BrokerShutdownStatus>

org.apache.kafka.clients.admin.BrokerShutdownStatus

All Implemented Interfaces:

Serializable, Comparable<BrokerShutdownStatus>

public enum BrokerShutdownStatus
extends Enum<BrokerShutdownStatus>

Denotes the status of the broker shutdown sub task of a given Confluent Balancer operation. Operations are free to give specific meaning to each broker shutdown status and its effect on the underlying operation, but in general: 1. ERROR - when the broker shutdown was started but did not complete successfully. Users may need to take corrective action to recover. 2. PENDING - when the broker is yet to be shut down. 3. IN_PROGRESS - when the broker is shutting down. 3. CANCELED - when a broker shutdown was canceled prior to initiation. 4. COMPLETED - when the broker has successfully been shut down. 5. UNKNOWN - clients will fall back to this status when they receive an unrecognized status value (since 7.0.0)

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELED
COMPLETED
ERROR
IN_PROGRESS
PENDING
UNKNOWN

Method Summary

Modifier and Type	Method and Description
static BrokerShutdownStatus	toEnum(String name)
static BrokerShutdownStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static BrokerShutdownStatus[]	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

ERROR

public static final BrokerShutdownStatus ERROR

PENDING

public static final BrokerShutdownStatus PENDING

IN_PROGRESS

public static final BrokerShutdownStatus IN_PROGRESS

CANCELED

public static final BrokerShutdownStatus CANCELED

COMPLETED

public static final BrokerShutdownStatus COMPLETED

UNKNOWN

public static final BrokerShutdownStatus UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

public static BrokerShutdownStatus 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 BrokerShutdownStatus toEnum(String name)