Package org.opensearch.indices.replication

Class SegmentReplicationState

java.lang.Object

org.opensearch.indices.replication.SegmentReplicationState

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, ReplicationState

@PublicApi(since="2.2.0")
public class SegmentReplicationState
extends Object
implements ReplicationState, org.opensearch.core.xcontent.ToXContentFragment, org.opensearch.core.common.io.stream.Writeable

ReplicationState implementation to track Segment Replication events.

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SegmentReplicationState.Stage	The stage of the recovery state

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

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

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SegmentReplicationState(ShardRouting shardRouting, ReplicationLuceneIndex index, long replicationId, String sourceDescription, DiscoveryNode targetNode)
SegmentReplicationState(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
org.opensearch.common.unit.TimeValue	getFileDiffStageTime()
org.opensearch.common.unit.TimeValue	getFinalizeReplicationStageTime()
org.opensearch.common.unit.TimeValue	getGetCheckpointInfoStageTime()
org.opensearch.common.unit.TimeValue	getGetFileStageTime()
ReplicationLuceneIndex	getIndex()
org.opensearch.common.unit.TimeValue	getReplicatingStageTime()
long	getReplicationId()
ShardRouting	getShardRouting()
String	getSourceDescription()
SegmentReplicationState.Stage	getStage()
DiscoveryNode	getTargetNode()
ReplicationTimer	getTimer()
Map<String,Long>	getTimingData()
void	setStage(SegmentReplicationState.Stage stage)
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
protected void	validateAndSetStage(SegmentReplicationState.Stage expected, SegmentReplicationState.Stage next)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

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

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

isFragment

Constructor Details

SegmentReplicationState

public SegmentReplicationState(ShardRouting shardRouting,
 ReplicationLuceneIndex index,
 long replicationId,
 String sourceDescription,
 DiscoveryNode targetNode)

SegmentReplicationState

public SegmentReplicationState(org.opensearch.core.common.io.stream.StreamInput in)
                        throws IOException

Throws:

IOException

Method Details

getShardRouting

public ShardRouting getShardRouting()

getIndex

public ReplicationLuceneIndex getIndex()

Specified by:

getIndex in interface ReplicationState

getReplicationId

public long getReplicationId()

getTimer

public ReplicationTimer getTimer()

Specified by:

getTimer in interface ReplicationState

getStage

public SegmentReplicationState.Stage getStage()

getSourceDescription

public String getSourceDescription()

getTargetNode

public DiscoveryNode getTargetNode()

getTimingData

public Map<String,Long> getTimingData()

getReplicatingStageTime

public org.opensearch.common.unit.TimeValue getReplicatingStageTime()

getGetCheckpointInfoStageTime

public org.opensearch.common.unit.TimeValue getGetCheckpointInfoStageTime()

getFileDiffStageTime

public org.opensearch.common.unit.TimeValue getFileDiffStageTime()

getGetFileStageTime

public org.opensearch.common.unit.TimeValue getGetFileStageTime()

getFinalizeReplicationStageTime

public org.opensearch.common.unit.TimeValue getFinalizeReplicationStageTime()

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

validateAndSetStage

protected void validateAndSetStage(SegmentReplicationState.Stage expected,
 SegmentReplicationState.Stage next)

setStage

public void setStage(SegmentReplicationState.Stage stage)

toXContent

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

Specified by:

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

Throws:

IOException