Package org.opensearch.client.opensearch._types

Enum Class NodeRole

java.lang.Object

java.lang.Enum<NodeRole>

org.opensearch.client.opensearch._types.NodeRole

All Implemented Interfaces:

Serializable, Comparable<NodeRole>, Constable, JsonEnum, JsonpSerializable

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public enum NodeRole
extends Enum<NodeRole>
implements JsonEnum

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.opensearch.client.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Client	The node can act as a client node.
ClusterManager	The node can act as a cluster manager.
CoordinatingOnly	The node only performs coordination tasks.
Data	The node can store data.
DataCold	The node can store cold data.
DataContent	The node can store content data.
DataFrozen	The node can store frozen data.
DataHot	The node can store hot data.
DataWarm	The node can store warm data.
Ingest	The node can perform ingest operations.
Master	Deprecated.
Ml	The node can perform machine learning operations.
RemoteClusterClient	The node can act as a remote cluster client.
Transform	The node can perform transform operations.
VotingOnly	The node can only vote in cluster decisions.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonEnum.Deserializer<NodeRole>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
String	jsonValue()
static NodeRole	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NodeRole[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.JsonEnum

aliases, serialize

Enum Constant Details

Client

public static final NodeRole Client

The node can act as a client node.

ClusterManager

public static final NodeRole ClusterManager

The node can act as a cluster manager.

CoordinatingOnly

public static final NodeRole CoordinatingOnly

The node only performs coordination tasks.

Data

public static final NodeRole Data

The node can store data.

DataCold

public static final NodeRole DataCold

The node can store cold data.

DataContent

public static final NodeRole DataContent

The node can store content data.

DataFrozen

public static final NodeRole DataFrozen

The node can store frozen data.

DataHot

public static final NodeRole DataHot

The node can store hot data.

DataWarm

public static final NodeRole DataWarm

The node can store warm data.

Ingest

public static final NodeRole Ingest

The node can perform ingest operations.

Master

@Deprecated
public static final NodeRole Master

Deprecated.

Ml

public static final NodeRole Ml

The node can perform machine learning operations.

RemoteClusterClient

public static final NodeRole RemoteClusterClient

The node can act as a remote cluster client.

Transform

public static final NodeRole Transform

The node can perform transform operations.

VotingOnly

public static final NodeRole VotingOnly

The node can only vote in cluster decisions.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<NodeRole> _DESERIALIZER

Method Details

values

public static NodeRole[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static NodeRole valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

jsonValue

public String jsonValue()

Specified by:

jsonValue in interface JsonEnum