Package org.elasticsearch.cluster.node

Class DiscoveryNodeRole

java.lang.Object

org.elasticsearch.cluster.node.DiscoveryNodeRole

All Implemented Interfaces:

java.lang.Comparable<DiscoveryNodeRole>

public abstract class DiscoveryNodeRole
extends java.lang.Object
implements java.lang.Comparable<DiscoveryNodeRole>

Represents a node role.

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.SortedSet<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.
static DiscoveryNodeRole	REMOTE_CLUSTER_CLIENT_ROLE
static Version	REMOTE_CLUSTER_CLIENT_ROLE_VERSION	The version that REMOTE_CLUSTER_CLIENT_ROLE is introduced.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DiscoveryNodeRole(java.lang.String roleName, java.lang.String roleNameAbbreviation)
protected	DiscoveryNodeRole(java.lang.String roleName, java.lang.String roleNameAbbreviation, boolean canContainData)

Method Summary

Modifier and Type	Method	Description
boolean	canContainData()	Indicates whether a node with this role can contain data.
int	compareTo(DiscoveryNodeRole o)
boolean	equals(java.lang.Object o)
DiscoveryNodeRole	getCompatibilityRole(Version nodeVersion)	When serializing a DiscoveryNodeRole, the role may not be available to nodes of previous versions, where the role had not yet been added.
int	hashCode()
boolean	isEnabledByDefault(Settings settings)
boolean	isKnownRole()	Whether this role is known by this node, or is an DiscoveryNodeRole.UnknownRole.
abstract Setting<java.lang.Boolean>	legacySetting()
java.lang.String	roleName()	The name of the role.
java.lang.String	roleNameAbbreviation()	The abbreviation of the name of the role.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Details

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.

REMOTE_CLUSTER_CLIENT_ROLE

public static final DiscoveryNodeRole REMOTE_CLUSTER_CLIENT_ROLE

BUILT_IN_ROLES

public static java.util.SortedSet<DiscoveryNodeRole> BUILT_IN_ROLES

The built-in node roles.

REMOTE_CLUSTER_CLIENT_ROLE_VERSION

public static final Version REMOTE_CLUSTER_CLIENT_ROLE_VERSION

The version that REMOTE_CLUSTER_CLIENT_ROLE is introduced. Nodes before this version do not have that role even they can connect to remote clusters.

Constructor Details

DiscoveryNodeRole

protected DiscoveryNodeRole(java.lang.String roleName, java.lang.String roleNameAbbreviation)

DiscoveryNodeRole

protected DiscoveryNodeRole(java.lang.String roleName, java.lang.String roleNameAbbreviation, boolean canContainData)

Method Details

roleName

public final java.lang.String roleName()

The name of the role.

Returns:

the role name

roleNameAbbreviation

public final java.lang.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

canContainData

public final boolean canContainData()

Indicates whether a node with this role can contain data.

Returns:

true if a node with this role can contain data, otherwise false

isKnownRole

public final boolean isKnownRole()

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

isEnabledByDefault

public boolean isEnabledByDefault(Settings settings)

legacySetting

public abstract Setting<java.lang.Boolean> legacySetting()

getCompatibilityRole

public DiscoveryNodeRole getCompatibilityRole(Version nodeVersion)

When serializing a DiscoveryNodeRole, the role may not be available to nodes of previous versions, where the role had not yet been added. This method allows overriding the role that should be serialized when communicating to versions prior to the introduction of the discovery node role.

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public final int compareTo(DiscoveryNodeRole o)

Specified by:

compareTo in interface java.lang.Comparable<DiscoveryNodeRole>

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object