org.apache.druid.discovery

Enum NodeRole

java.lang.Object

java.lang.Enum<NodeRole>

org.apache.druid.discovery.NodeRole

All Implemented Interfaces:

Serializable, Comparable<NodeRole>

public enum NodeRole
extends Enum<NodeRole>

This is a historical occasion that this enum is different from ServerType (also called "node type" in various places) because they are essentially the same abstraction, but merging them could only increase the complexity and drop the code safety, because they name the same types differently ("peon" - "indexer-executor" and "middleManager" - "realtime") and both expose them via JSON APIs. These abstractions can probably be merged when Druid updates to Jackson 2.9 that supports JsonAliases, see see https://github.com/apache/druid/issues/7152.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BROKER
COORDINATOR
HISTORICAL
INDEXER
MIDDLE_MANAGER
OVERLORD
PEON
ROUTER

Method Summary

Modifier and Type	Method and Description
String	getJsonName() Lowercase for backward compatibility, as a part of the DiscoveryDruidNode's JSON format.
static NodeRole	valueOf(String name) Returns the enum constant of this type with the specified name.
static NodeRole[]	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

COORDINATOR

public static final NodeRole COORDINATOR

HISTORICAL

public static final NodeRole HISTORICAL

BROKER

public static final NodeRole BROKER

OVERLORD

public static final NodeRole OVERLORD

PEON

public static final NodeRole PEON

ROUTER

public static final NodeRole ROUTER

MIDDLE_MANAGER

public static final NodeRole MIDDLE_MANAGER

INDEXER

public static final NodeRole INDEXER

Method Detail

values

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

Returns:

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

valueOf

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

getJsonName

public String getJsonName()

Lowercase for backward compatibility, as a part of the DiscoveryDruidNode's JSON format. Don't need to define JsonCreator because for enum types JsonValue serves for both serialization and deserialization, see the Javadoc comment of JsonValue.