Package org.opensearch.action.admin.indices.stats

Class ShardStats

java.lang.Object

org.opensearch.action.admin.indices.stats.ShardStats

All Implemented Interfaces:

Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public class ShardStats
extends java.lang.Object
implements Writeable, org.opensearch.common.xcontent.ToXContentFragment

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

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

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

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ShardStats(ShardRouting routing, ShardPath shardPath, CommonStats commonStats, CommitStats commitStats, SeqNoStats seqNoStats, RetentionLeaseStats retentionLeaseStats)
ShardStats(StreamInput in)

Method Summary

Modifier and Type	Method	Description
CommitStats	getCommitStats()
java.lang.String	getDataPath()
RetentionLeaseStats	getRetentionLeaseStats()	Gets the current retention lease stats.
SeqNoStats	getSeqNoStats()
ShardRouting	getShardRouting()	The shard routing information (cluster wide shard state).
java.lang.String	getStatePath()
CommonStats	getStats()
boolean	isCustomDataPath()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Constructor Details

ShardStats

public ShardStats(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

ShardStats

public ShardStats(ShardRouting routing, ShardPath shardPath, CommonStats commonStats, CommitStats commitStats, SeqNoStats seqNoStats, RetentionLeaseStats retentionLeaseStats)

Method Details

getRetentionLeaseStats

public RetentionLeaseStats getRetentionLeaseStats()

Gets the current retention lease stats.

Returns:

the current retention lease stats

getShardRouting

public ShardRouting getShardRouting()

The shard routing information (cluster wide shard state).

getStats

public CommonStats getStats()

getCommitStats

@Nullable public CommitStats getCommitStats()

getSeqNoStats

@Nullable public SeqNoStats getSeqNoStats()

getDataPath

public java.lang.String getDataPath()

getStatePath

public java.lang.String getStatePath()

isCustomDataPath

public boolean isCustomDataPath()

writeTo

public void writeTo(StreamOutput out) throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

java.io.IOException