org.elasticsearch.cluster.node

Class DiscoveryNode

java.lang.Object

org.elasticsearch.cluster.node.DiscoveryNode

All Implemented Interfaces:

Streamable, ToXContent

public class DiscoveryNode
extends Object
implements Streamable, ToXContent

A discovery node represents a node that is part of the cluster.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_ATTR
static String	DATA_ATTR
static List<DiscoveryNode>	EMPTY_LIST
static String	INGEST_ATTR
static String	MASTER_ATTR
static Version	MINIMUM_DISCOVERY_NODE_VERSION Minimum version of a node to communicate with.

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
DiscoveryNode(String nodeName, String nodeId, String hostName, String hostAddress, TransportAddress address, Map<String,String> attributes, Version version) Creates a new DiscoveryNode
DiscoveryNode(String nodeName, String nodeId, TransportAddress address, Map<String,String> attributes, Version version) Creates a new DiscoveryNode
DiscoveryNode(String nodeId, TransportAddress address, Version version) Creates a new DiscoveryNode

Method Summary

Methods

Modifier and Type	Method and Description
TransportAddress	address() The address that the node can be communicated with.
com.google.common.collect.ImmutableMap<String,String>	attributes() The node attributes.
boolean	clientNode() Is the node a client node or not.
static boolean	clientNode(Settings settings)
boolean	dataNode() Should this node hold data (shards) or not.
static boolean	dataNode(Settings settings)
boolean	equals(Object obj)
TransportAddress	getAddress() The address that the node can be communicated with.
com.google.common.collect.ImmutableMap<String,String>	getAttributes() The node attributes.
String	getHostAddress()
String	getHostName()
String	getId() The unique id of the node.
String	getName() The name of the node.
Version	getVersion()
int	hashCode()
String	id() The unique id of the node.
boolean	isClientNode()
boolean	isDataNode() Should this node hold data (shards) or not.
boolean	isIngestNode() Returns a boolean that tells whether this an ingest node or not
boolean	isMasterNode() Can this node become master or not.
static boolean	localNode(Settings settings)
boolean	masterNode() Can this node become master or not.
static boolean	masterNode(Settings settings)
String	name() The name of the node.
static boolean	nodeRequiresLocalStorage(Settings settings)
void	readFrom(StreamInput in)
static DiscoveryNode	readNode(StreamInput in)
boolean	shouldConnectTo(DiscoveryNode otherNode) Should this node form a connection to the provided node.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Version	version()
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

MINIMUM_DISCOVERY_NODE_VERSION

public static final Version MINIMUM_DISCOVERY_NODE_VERSION

Minimum version of a node to communicate with. This version corresponds to the minimum compatibility version of the current elasticsearch major version.

DATA_ATTR

public static final String DATA_ATTR

See Also:

Constant Field Values

MASTER_ATTR

public static final String MASTER_ATTR

See Also:

Constant Field Values

CLIENT_ATTR

public static final String CLIENT_ATTR

See Also:

Constant Field Values

INGEST_ATTR

public static final String INGEST_ATTR

See Also:

Constant Field Values

EMPTY_LIST

public static final List<DiscoveryNode> EMPTY_LIST

Constructor Detail

DiscoveryNode

public DiscoveryNode(String nodeId,
             TransportAddress address,
             Version version)

Creates a new DiscoveryNode

Note: if the version of the node is unknown MINIMUM_DISCOVERY_NODE_VERSION should be used. it corresponds to the minimum version this elasticsearch version can communicate with. If a higher version is used the node might not be able to communicate with the remove node. After initial handshakes node versions will be discovered and updated.

Parameters:

nodeId - the nodes unique id.

address - the nodes transport address

version - the version of the node.

DiscoveryNode

public DiscoveryNode(String nodeName,
             String nodeId,
             TransportAddress address,
             Map<String,String> attributes,
             Version version)

Creates a new DiscoveryNode

Note: if the version of the node is unknown MINIMUM_DISCOVERY_NODE_VERSION should be used. it corresponds to the minimum version this elasticsearch version can communicate with. If a higher version is used the node might not be able to communicate with the remove node. After initial handshakes node versions will be discovered and updated.

Parameters:

nodeName - the nodes name

nodeId - the nodes unique id.

address - the nodes transport address

attributes - node attributes

version - the version of the node.

DiscoveryNode

public DiscoveryNode(String nodeName,
             String nodeId,
             String hostName,
             String hostAddress,
             TransportAddress address,
             Map<String,String> attributes,
             Version version)

Creates a new DiscoveryNode

Note: if the version of the node is unknown MINIMUM_DISCOVERY_NODE_VERSION should be used. it corresponds to the minimum version this elasticsearch version can communicate with. If a higher version is used the node might not be able to communicate with the remove node. After initial handshakes node versions will be discovered and updated.

Parameters:

nodeName - the nodes name

nodeId - the nodes unique id.

hostName - the nodes hostname

hostAddress - the nodes host address

address - the nodes transport address

attributes - node attributes

version - the version of the node.

Method Detail

localNode

public static boolean localNode(Settings settings)

nodeRequiresLocalStorage

public static boolean nodeRequiresLocalStorage(Settings settings)

clientNode

public static boolean clientNode(Settings settings)

masterNode

public static boolean masterNode(Settings settings)

dataNode

public static boolean dataNode(Settings settings)

shouldConnectTo

public boolean shouldConnectTo(DiscoveryNode otherNode)

Should this node form a connection to the provided node.

address

public TransportAddress address()

The address that the node can be communicated with.

getAddress

public TransportAddress getAddress()

The address that the node can be communicated with.

id

public String id()

The unique id of the node.

getId

public String getId()

The unique id of the node.

name

public String name()

The name of the node.

getName

public String getName()

The name of the node.

attributes

public com.google.common.collect.ImmutableMap<String,String> attributes()

The node attributes.

getAttributes

public com.google.common.collect.ImmutableMap<String,String> getAttributes()

The node attributes.

dataNode

public boolean dataNode()

Should this node hold data (shards) or not.

isDataNode

public boolean isDataNode()

Should this node hold data (shards) or not.

clientNode

public boolean clientNode()

Is the node a client node or not.

isClientNode

public boolean isClientNode()

masterNode

public boolean masterNode()

Can this node become master or not.

isMasterNode

public boolean isMasterNode()

Can this node become master or not.

isIngestNode

public boolean isIngestNode()

Returns a boolean that tells whether this an ingest node or not

version

public Version version()

getHostName

public String getHostName()

getHostAddress

public String getHostAddress()

getVersion

public Version getVersion()

readNode

public static DiscoveryNode readNode(StreamInput in)
                              throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException