Module org.elasticsearch.server

Package org.elasticsearch.cluster

Class ClusterInfo

java.lang.Object

org.elasticsearch.cluster.ClusterInfo

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public class ClusterInfo
extends Object
implements ToXContentFragment, Writeable

ClusterInfo is an object representing a map of nodes to DiskUsage and a map of shard ids to shard sizes, see InternalClusterInfoService.shardIdentifierFromRouting(String) for the key used in the shardSizes map

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ClusterInfo.NodeAndPath	Represents a data path on a node
static final record	ClusterInfo.NodeAndShard
static final record	ClusterInfo.ReservedSpace	Represents the total amount of "reserved" space on a particular data path, together with the set of shards considered.

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final TransportVersion	DATA_PATH_NEW_KEY_VERSION
static final TransportVersion	DATA_SET_SIZE_SIZE_VERSION
static final ClusterInfo	EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClusterInfo()
	ClusterInfo(Map<String,DiskUsage> leastAvailableSpaceUsage, Map<String,DiskUsage> mostAvailableSpaceUsage, Map<String,Long> shardSizes, Map<ShardId,Long> shardDataSetSizes, Map<ClusterInfo.NodeAndShard,String> dataPath, Map<ClusterInfo.NodeAndPath,ClusterInfo.ReservedSpace> reservedSpace)	Creates a new ClusterInfo instance.
	ClusterInfo(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDataPath(ClusterInfo.NodeAndShard nodeAndShard)
String	getDataPath(ShardRouting shardRouting)	Returns the nodes absolute data-path the given shard is allocated on or null if the information is not available.
Map<String,DiskUsage>	getNodeLeastAvailableDiskUsages()	Returns a node id to disk usage mapping for the path that has the least available space on the node.
Map<String,DiskUsage>	getNodeMostAvailableDiskUsages()	Returns a node id to disk usage mapping for the path that has the most available space on the node.
ClusterInfo.ReservedSpace	getReservedSpace(String nodeId, String dataPath)	Returns the reserved space for each shard on the given node/path pair
Optional<Long>	getShardDataSetSize(ShardId shardId)
Long	getShardSize(ShardRouting shardRouting)	Returns the shard size for the given shard routing or null if that metric is not available.
long	getShardSize(ShardRouting shardRouting, long defaultValue)	Returns the shard size for the given shard routing or defaultValue it that metric is not available.
Long	getShardSize(ShardId shardId, boolean primary)	Returns the shard size for the given shardId or null if that metric is not available.
int	hashCode()
static String	shardIdentifierFromRouting(ShardRouting shardRouting)	Method that incorporates the ShardId for the shard into a string that includes a 'p' or 'r' depending on whether the shard is a primary.
static String	shardIdentifierFromRouting(ShardId shardId, boolean primary)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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.xcontent.ToXContentFragment

isFragment

Field Details

EMPTY

public static final ClusterInfo EMPTY

DATA_SET_SIZE_SIZE_VERSION

public static final TransportVersion DATA_SET_SIZE_SIZE_VERSION

DATA_PATH_NEW_KEY_VERSION

public static final TransportVersion DATA_PATH_NEW_KEY_VERSION

Constructor Details

ClusterInfo

protected ClusterInfo()

ClusterInfo

public ClusterInfo(Map<String,DiskUsage> leastAvailableSpaceUsage,
 Map<String,DiskUsage> mostAvailableSpaceUsage,
 Map<String,Long> shardSizes,
 Map<ShardId,Long> shardDataSetSizes,
 Map<ClusterInfo.NodeAndShard,String> dataPath,
 Map<ClusterInfo.NodeAndPath,ClusterInfo.ReservedSpace> reservedSpace)

Creates a new ClusterInfo instance.

Parameters:

leastAvailableSpaceUsage - a node id to disk usage mapping for the path that has the least available space on the node.

mostAvailableSpaceUsage - a node id to disk usage mapping for the path that has the most available space on the node.

shardSizes - a shardkey to size in bytes mapping per shard.

shardDataSetSizes - a shard id to data set size in bytes mapping per shard

dataPath - the shard routing to datapath mapping

reservedSpace - reserved space per shard broken down by node and data path

See Also:

• shardIdentifierFromRouting(org.elasticsearch.cluster.routing.ShardRouting)

ClusterInfo

public ClusterInfo(StreamInput in)
            throws IOException

Throws:

IOException

Method Details

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getNodeLeastAvailableDiskUsages

public Map<String,DiskUsage> getNodeLeastAvailableDiskUsages()

Returns a node id to disk usage mapping for the path that has the least available space on the node. Note that this does not take account of reserved space: there may be another path with less available _and unreserved_ space.

getNodeMostAvailableDiskUsages

public Map<String,DiskUsage> getNodeMostAvailableDiskUsages()

Returns a node id to disk usage mapping for the path that has the most available space on the node. Note that this does not take account of reserved space: there may be another path with more available _and unreserved_ space.

getShardSize

public Long getShardSize(ShardId shardId,
 boolean primary)

Returns the shard size for the given shardId or null if that metric is not available.

getShardSize

public Long getShardSize(ShardRouting shardRouting)

Returns the shard size for the given shard routing or null if that metric is not available.

getShardSize

public long getShardSize(ShardRouting shardRouting,
 long defaultValue)

Returns the shard size for the given shard routing or defaultValue it that metric is not available.

getDataPath

public String getDataPath(ShardRouting shardRouting)

Returns the nodes absolute data-path the given shard is allocated on or null if the information is not available.

getDataPath

public String getDataPath(ClusterInfo.NodeAndShard nodeAndShard)

getShardDataSetSize

public Optional<Long> getShardDataSetSize(ShardId shardId)

getReservedSpace

public ClusterInfo.ReservedSpace getReservedSpace(String nodeId,
 String dataPath)

Returns the reserved space for each shard on the given node/path pair

shardIdentifierFromRouting

public static String shardIdentifierFromRouting(ShardRouting shardRouting)

Method that incorporates the ShardId for the shard into a string that includes a 'p' or 'r' depending on whether the shard is a primary.

shardIdentifierFromRouting

public static String shardIdentifierFromRouting(ShardId shardId,
 boolean primary)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object