org.elasticsearch.cluster

Class ClusterState

java.lang.Object

org.elasticsearch.cluster.ClusterState

All Implemented Interfaces:

ToXContent

public class ClusterState
extends Object
implements ToXContent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterState.Builder
static class	ClusterState.ClusterStateStatus
static interface	ClusterState.Custom
static class	ClusterState.Metric

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 long	UNKNOWN_VERSION

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
ClusterState(ClusterName clusterName, long version, MetaData metaData, RoutingTable routingTable, DiscoveryNodes nodes, ClusterBlocks blocks, ImmutableOpenMap<String,ClusterState.Custom> customs)
ClusterState(long version, ClusterState state)

Method Summary

Modifier and Type	Method and Description
ClusterBlocks	blocks()
static ClusterState.Builder	builder(ClusterName clusterName)
static ClusterState.Builder	builder(ClusterState state)
ImmutableOpenMap<String,ClusterState.Custom>	customs()
ClusterBlocks	getBlocks()
ClusterName	getClusterName()
ImmutableOpenMap<String,ClusterState.Custom>	getCustoms()
MetaData	getMetaData()
DiscoveryNodes	getNodes()
RoutingNodes	getRoutingNodes()
RoutingTable	getRoutingTable()
long	getVersion()
static <T extends ClusterState.Custom> ClusterState.Custom.Factory<T>	lookupFactory(String type)
static <T extends ClusterState.Custom> ClusterState.Custom.Factory<T>	lookupFactorySafe(String type)
MetaData	metaData()
DiscoveryNodes	nodes()
String	prettyPrint()
RoutingNodes	readOnlyRoutingNodes() Returns a built (on demand) routing nodes view of the routing table.
static void	registerFactory(String type, ClusterState.Custom.Factory factory) Register a custom index meta data factory.
RoutingNodes	routingNodes()
RoutingTable	routingTable()
ClusterState	settingsFilter(SettingsFilter settingsFilter)
ClusterState.ClusterStateStatus	status()
ClusterState	status(ClusterState.ClusterStateStatus newStatus)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
long	version()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN_VERSION

public static final long UNKNOWN_VERSION

See Also:

Constant Field Values

Constructor Detail

ClusterState

public ClusterState(long version,
                    ClusterState state)

ClusterState

public ClusterState(ClusterName clusterName,
                    long version,
                    MetaData metaData,
                    RoutingTable routingTable,
                    DiscoveryNodes nodes,
                    ClusterBlocks blocks,
                    ImmutableOpenMap<String,ClusterState.Custom> customs)

Method Detail

registerFactory

public static void registerFactory(String type,
                                   ClusterState.Custom.Factory factory)

Register a custom index meta data factory. Make sure to call it from a static block.

lookupFactory

@Nullable
public static <T extends ClusterState.Custom> ClusterState.Custom.Factory<T> lookupFactory(String type)

lookupFactorySafe

public static <T extends ClusterState.Custom> ClusterState.Custom.Factory<T> lookupFactorySafe(String type)
                                                                                        throws ElasticsearchIllegalArgumentException

Throws:

ElasticsearchIllegalArgumentException

status

public ClusterState.ClusterStateStatus status()

status

public ClusterState status(ClusterState.ClusterStateStatus newStatus)

version

public long version()

getVersion

public long getVersion()

nodes

public DiscoveryNodes nodes()

getNodes

public DiscoveryNodes getNodes()

metaData

public MetaData metaData()

getMetaData

public MetaData getMetaData()

routingTable

public RoutingTable routingTable()

getRoutingTable

public RoutingTable getRoutingTable()

routingNodes

public RoutingNodes routingNodes()

getRoutingNodes

public RoutingNodes getRoutingNodes()

blocks

public ClusterBlocks blocks()

getBlocks

public ClusterBlocks getBlocks()

customs

public ImmutableOpenMap<String,ClusterState.Custom> customs()

getCustoms

public ImmutableOpenMap<String,ClusterState.Custom> getCustoms()

getClusterName

public ClusterName getClusterName()

readOnlyRoutingNodes

public RoutingNodes readOnlyRoutingNodes()

Returns a built (on demand) routing nodes view of the routing table. NOTE, the routing nodes are mutable, use them just for read operations

settingsFilter

public ClusterState settingsFilter(SettingsFilter settingsFilter)

prettyPrint

public String prettyPrint()

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

builder

public static ClusterState.Builder builder(ClusterName clusterName)

builder

public static ClusterState.Builder builder(ClusterState state)