Module org.elasticsearch.server

Package org.elasticsearch.cluster

Record Class ClusterSnapshotStats

java.lang.Object

java.lang.Record

org.elasticsearch.cluster.ClusterSnapshotStats

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public record ClusterSnapshotStats(int snapshotsInProgressCount, int incompleteShardSnapshotCount, int deletionsInProgressCount, int cleanupsInProgressCount, List<org.elasticsearch.cluster.ClusterSnapshotStats.PerRepositoryStats> statsByRepository)
extends Record
implements ToXContentObject, Writeable

Nested Class Summary

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 ClusterSnapshotStats	EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ClusterSnapshotStats(int snapshotsInProgressCount, int incompleteShardSnapshotCount, int deletionsInProgressCount, int cleanupsInProgressCount, List<org.elasticsearch.cluster.ClusterSnapshotStats.PerRepositoryStats> statsByRepository)	Creates an instance of a ClusterSnapshotStats record class.

Method Summary

Modifier and Type	Method	Description
int	cleanupsInProgressCount()	Returns the value of the cleanupsInProgressCount record component.
int	deletionsInProgressCount()	Returns the value of the deletionsInProgressCount 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.
int	incompleteShardSnapshotCount()	Returns the value of the incompleteShardSnapshotCount record component.
static ClusterSnapshotStats	of(ClusterState clusterState, long currentTimeMillis)
static ClusterSnapshotStats	readFrom(StreamInput in)
int	snapshotsInProgressCount()	Returns the value of the snapshotsInProgressCount record component.
List<org.elasticsearch.cluster.ClusterSnapshotStats.PerRepositoryStats>	statsByRepository()	Returns the value of the statsByRepository record component.
final String	toString()	Returns a string representation of this record class.
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.ToXContentObject

isFragment

Field Details

EMPTY

public static ClusterSnapshotStats EMPTY

Constructor Details

ClusterSnapshotStats

public ClusterSnapshotStats(int snapshotsInProgressCount,
 int incompleteShardSnapshotCount,
 int deletionsInProgressCount,
 int cleanupsInProgressCount,
 List<org.elasticsearch.cluster.ClusterSnapshotStats.PerRepositoryStats> statsByRepository)

Creates an instance of a ClusterSnapshotStats record class.

Parameters:

snapshotsInProgressCount - the value for the snapshotsInProgressCount record component

incompleteShardSnapshotCount - the value for the incompleteShardSnapshotCount record component

deletionsInProgressCount - the value for the deletionsInProgressCount record component

cleanupsInProgressCount - the value for the cleanupsInProgressCount record component

statsByRepository - the value for the statsByRepository record component

Method Details

of

public static ClusterSnapshotStats of(ClusterState clusterState,
 long currentTimeMillis)

toXContent

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

Specified by:

toXContent in interface ToXContent

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

readFrom

public static ClusterSnapshotStats readFrom(StreamInput in)
                                     throws IOException

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

snapshotsInProgressCount

public int snapshotsInProgressCount()

Returns the value of the snapshotsInProgressCount record component.

Returns:

the value of the snapshotsInProgressCount record component

incompleteShardSnapshotCount

public int incompleteShardSnapshotCount()

Returns the value of the incompleteShardSnapshotCount record component.

Returns:

the value of the incompleteShardSnapshotCount record component

deletionsInProgressCount

public int deletionsInProgressCount()

Returns the value of the deletionsInProgressCount record component.

Returns:

the value of the deletionsInProgressCount record component

cleanupsInProgressCount

public int cleanupsInProgressCount()

Returns the value of the cleanupsInProgressCount record component.

Returns:

the value of the cleanupsInProgressCount record component

statsByRepository

public List<org.elasticsearch.cluster.ClusterSnapshotStats.PerRepositoryStats> statsByRepository()

Returns the value of the statsByRepository record component.

Returns:

the value of the statsByRepository record component