Module org.elasticsearch.server

Package org.elasticsearch.health.node

Record Class HealthInfo

java.lang.Object

java.lang.Record

org.elasticsearch.health.node.HealthInfo

Record Components:

diskInfoByNode - A Map of node id to DiskHealthInfo for that node

dslHealthInfo - The data stream lifecycle health information

repositoriesInfoByNode - A Map of node id to RepositoriesHealthInfo for that node

All Implemented Interfaces:

Writeable

public record HealthInfo(Map<String,DiskHealthInfo> diskInfoByNode, DataStreamLifecycleHealthInfo dslHealthInfo, Map<String,RepositoriesHealthInfo> repositoriesInfoByNode)
extends Record
implements Writeable

This class wraps all the data returned by the health node.

Nested Class Summary

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 HealthInfo	EMPTY_HEALTH_INFO

Constructor Summary

Constructors

Constructor	Description
HealthInfo(Map<String,DiskHealthInfo> diskInfoByNode, DataStreamLifecycleHealthInfo dslHealthInfo, Map<String,RepositoriesHealthInfo> repositoriesInfoByNode)	Creates an instance of a HealthInfo record class.
HealthInfo(StreamInput input)

Method Summary

Modifier and Type	Method	Description
Map<String,DiskHealthInfo>	diskInfoByNode()	Returns the value of the diskInfoByNode record component.
DataStreamLifecycleHealthInfo	dslHealthInfo()	Returns the value of the dslHealthInfo record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Map<String,RepositoriesHealthInfo>	repositoriesInfoByNode()	Returns the value of the repositoriesInfoByNode record component.
final String	toString()	Returns a string representation of this record class.
void	writeTo(StreamOutput output)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_HEALTH_INFO

public static final HealthInfo EMPTY_HEALTH_INFO

Constructor Details

HealthInfo

public HealthInfo(StreamInput input)
           throws IOException

Throws:

IOException

HealthInfo

public HealthInfo(Map<String,DiskHealthInfo> diskInfoByNode,
 @Nullable
 DataStreamLifecycleHealthInfo dslHealthInfo,
 Map<String,RepositoriesHealthInfo> repositoriesInfoByNode)

Creates an instance of a HealthInfo record class.

Parameters:

diskInfoByNode - the value for the diskInfoByNode record component

dslHealthInfo - the value for the dslHealthInfo record component

repositoriesInfoByNode - the value for the repositoriesInfoByNode record component

Method Details

writeTo

public void writeTo(StreamOutput output)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

diskInfoByNode

public Map<String,DiskHealthInfo> diskInfoByNode()

Returns the value of the diskInfoByNode record component.

Returns:

the value of the diskInfoByNode record component

dslHealthInfo

@Nullable
public DataStreamLifecycleHealthInfo dslHealthInfo()

Returns the value of the dslHealthInfo record component.

Returns:

the value of the dslHealthInfo record component

repositoriesInfoByNode

public Map<String,RepositoriesHealthInfo> repositoriesInfoByNode()

Returns the value of the repositoriesInfoByNode record component.

Returns:

the value of the repositoriesInfoByNode record component