Module org.elasticsearch.server

Package org.elasticsearch.health.metadata

Class HealthMetadata

java.lang.Object

org.elasticsearch.cluster.AbstractNamedDiffable<ClusterState.Custom>

org.elasticsearch.health.metadata.HealthMetadata

All Implemented Interfaces:

ClusterState.Custom, Diffable<ClusterState.Custom>, NamedDiffable<ClusterState.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, ChunkedToXContent

public final class HealthMetadata
extends AbstractNamedDiffable<ClusterState.Custom>
implements ClusterState.Custom

A cluster state entry that contains a list of all the thresholds used to determine if a node is healthy.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HealthMetadata.Builder
static final record	HealthMetadata.Disk	Contains the thresholds necessary to determine the health of the disk space of a node.
static final record	HealthMetadata.ShardLimits	Contains the thresholds needed to determine the health of a cluster when it comes to the amount of room available to create new shards.

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 String	TYPE

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
HealthMetadata(StreamInput in)
HealthMetadata(HealthMetadata.Disk diskMetadata, HealthMetadata.ShardLimits shardLimitsMetadata)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
HealthMetadata.Disk	getDiskMetadata()
static HealthMetadata	getFromClusterState(ClusterState clusterState)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
HealthMetadata.ShardLimits	getShardLimitsMetadata()
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
static HealthMetadata.Builder	newBuilder(HealthMetadata healthMetadata)
static NamedDiff<ClusterState.Custom>	readDiffFrom(StreamInput in)
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params ignored)	Serialize this ClusterState.Custom for diagnostic purposes, exposed by the
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.cluster.AbstractNamedDiffable

diff, get, readDiffFrom

Methods inherited from class java.lang.Object

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

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

isFragment, toXContentChunkedV7

Methods inherited from interface org.elasticsearch.cluster.ClusterState.Custom

isPrivate

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

HealthMetadata

public HealthMetadata(HealthMetadata.Disk diskMetadata,
 HealthMetadata.ShardLimits shardLimitsMetadata)

HealthMetadata

public HealthMetadata(StreamInput in)
               throws IOException

Throws:

IOException

Method Details

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

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

readDiffFrom

public static NamedDiff<ClusterState.Custom> readDiffFrom(StreamInput in)
                                                   throws IOException

Throws:

IOException

toXContentChunked

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

Description copied from interface: ClusterState.Custom

Serialize this ClusterState.Custom for diagnostic purposes, exposed by the

GET _cluster/state

API etc. The XContent representation does not need to be 100% faithful since we never reconstruct a cluster state from its XContent representation, but the more faithful it is the more useful it is for diagnostics.

Specified by:

toXContentChunked in interface ChunkedToXContent

Specified by:

toXContentChunked in interface ClusterState.Custom

Returns:

iterator over chunks of ToXContent

getFromClusterState

public static HealthMetadata getFromClusterState(ClusterState clusterState)

getDiskMetadata

public HealthMetadata.Disk getDiskMetadata()

getShardLimitsMetadata

public HealthMetadata.ShardLimits getShardLimitsMetadata()

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

newBuilder

public static HealthMetadata.Builder newBuilder(HealthMetadata healthMetadata)