Module org.elasticsearch.server

Package org.elasticsearch.cluster

Class ClusterFeatures

java.lang.Object

org.elasticsearch.cluster.ClusterFeatures

All Implemented Interfaces:

Diffable<ClusterFeatures>, Writeable, ChunkedToXContent, ChunkedToXContentObject

public class ClusterFeatures
extends Object
implements Diffable<ClusterFeatures>, ChunkedToXContentObject

Stores information on what features are present throughout the cluster

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
ClusterFeatures(Map<String,Set<String>> nodeFeatures)

Method Summary

Modifier and Type	Method	Description
Set<String>	allNodeFeatures()	The features in all nodes in the cluster.
static Set<String>	calculateAllNodeFeatures(Collection<Set<String>> nodeFeatures)
boolean	clusterHasFeature(NodeFeature feature)	true if feature is present on all nodes in the cluster.
Diff<ClusterFeatures>	diff(ClusterFeatures previousState)	Returns serializable object representing differences between this and previousState
boolean	equals(Object obj)
int	hashCode()
Map<String,Set<String>>	nodeFeatures()	The features reported by each node in the cluster.
static Diff<ClusterFeatures>	readDiffFrom(StreamInput in)
static ClusterFeatures	readFrom(StreamInput in)
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)	Create an iterator of ToXContent chunks for a REST response.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

toXContentChunkedV7

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContentObject

isFragment

Constructor Details

ClusterFeatures

public ClusterFeatures(Map<String,Set<String>> nodeFeatures)

Method Details

calculateAllNodeFeatures

public static Set<String> calculateAllNodeFeatures(Collection<Set<String>> nodeFeatures)

nodeFeatures

public Map<String,Set<String>> nodeFeatures()

The features reported by each node in the cluster.

NOTE: This should not be used directly. Please use FeatureService.clusterHasFeature(org.elasticsearch.cluster.ClusterState, org.elasticsearch.features.NodeFeature) instead.

allNodeFeatures

public Set<String> allNodeFeatures()

The features in all nodes in the cluster.

NOTE: This should not be used directly. Please use FeatureService.clusterHasFeature(org.elasticsearch.cluster.ClusterState, org.elasticsearch.features.NodeFeature) instead.

clusterHasFeature

public boolean clusterHasFeature(NodeFeature feature)

true if feature is present on all nodes in the cluster.

NOTE: This should not be used directly, as it does not read historical features. Please use FeatureService.clusterHasFeature(org.elasticsearch.cluster.ClusterState, org.elasticsearch.features.NodeFeature) instead.

readFrom

public static ClusterFeatures readFrom(StreamInput in)
                                throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

diff

public Diff<ClusterFeatures> diff(ClusterFeatures previousState)

Description copied from interface: Diffable

Returns serializable object representing differences between this and previousState

Specified by:

diff in interface Diffable<ClusterFeatures>

readDiffFrom

public static Diff<ClusterFeatures> readDiffFrom(StreamInput in)
                                          throws IOException

Throws:

IOException

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object