Package org.elasticsearch.cluster.node

Class DiscoveryNodeRole

java.lang.Object

org.elasticsearch.cluster.node.DiscoveryNodeRole

public abstract class DiscoveryNodeRole
extends Object

Represents a node role.

Field Summary

Fields

Modifier and Type	Field	Description
static Set<DiscoveryNodeRole>	BUILT_IN_ROLES	The built-in node roles.
static DiscoveryNodeRole	DATA_ROLE	Represents the role for a data node.
static DiscoveryNodeRole	INGEST_ROLE	Represents the role for an ingest node.
static DiscoveryNodeRole	MASTER_ROLE	Represents the role for a master-eligible node.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DiscoveryNodeRole(String roleName, String roleNameAbbreviation)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
boolean	isKnownRole()	Whether this role is known by this node, or is an DiscoveryNodeRole.UnknownRole.
String	roleName()	The name of the role.
String	roleNameAbbreviation()	The abbreviation of the name of the role.
protected abstract Setting<Boolean>	roleSetting()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DATA_ROLE

public static final DiscoveryNodeRole DATA_ROLE

Represents the role for a data node.

INGEST_ROLE

public static final DiscoveryNodeRole INGEST_ROLE

Represents the role for an ingest node.

MASTER_ROLE

public static final DiscoveryNodeRole MASTER_ROLE

Represents the role for a master-eligible node.

BUILT_IN_ROLES

public static Set<DiscoveryNodeRole> BUILT_IN_ROLES

The built-in node roles.

Constructor Detail

DiscoveryNodeRole

protected DiscoveryNodeRole(String roleName,
                            String roleNameAbbreviation)

Method Detail

roleName

public final String roleName()

The name of the role.

Returns:

the role name

roleNameAbbreviation

public final String roleNameAbbreviation()

The abbreviation of the name of the role. This is used in the cat nodes API to display an abbreviated version of the name of the role.

Returns:

the role name abbreviation

isKnownRole

public final boolean isKnownRole()

Whether this role is known by this node, or is an DiscoveryNodeRole.UnknownRole.

roleSetting

protected abstract Setting<Boolean> roleSetting()

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object