Package org.opensearch.indices.recovery

Class RecoveryState

java.lang.Object

org.opensearch.indices.recovery.RecoveryState

All Implemented Interfaces:

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

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

Keeps track of state related to shard recovery.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RecoveryState.FileDetail
static class	RecoveryState.Index
static class	RecoveryState.RecoveryFilesDetails
static class	RecoveryState.Stage
static class	RecoveryState.Timer
static class	RecoveryState.Translog
static class	RecoveryState.VerifyIndex

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
RecoveryState(ShardRouting shardRouting, DiscoveryNode targetNode, DiscoveryNode sourceNode)
RecoveryState(ShardRouting shardRouting, DiscoveryNode targetNode, DiscoveryNode sourceNode, RecoveryState.Index index)
RecoveryState(StreamInput in)

Method Summary

Modifier and Type	Method	Description
RecoveryState.Index	getIndex()
boolean	getPrimary()
RecoverySource	getRecoverySource()
ShardId	getShardId()
DiscoveryNode	getSourceNode()	Returns recovery source node (only non-null if peer recovery)
RecoveryState.Stage	getStage()
DiscoveryNode	getTargetNode()
RecoveryState.Timer	getTimer()
RecoveryState.Translog	getTranslog()
RecoveryState.VerifyIndex	getVerifyIndex()
static RecoveryState	readRecoveryState(StreamInput in)
RecoveryState	setStage(RecoveryState.Stage stage)
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
protected void	validateAndSetStage(RecoveryState.Stage expected, RecoveryState.Stage next)
void	validateCurrentStage(RecoveryState.Stage expected)
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

RecoveryState

public RecoveryState(ShardRouting shardRouting, DiscoveryNode targetNode, @Nullable DiscoveryNode sourceNode)

RecoveryState

public RecoveryState(ShardRouting shardRouting, DiscoveryNode targetNode, @Nullable DiscoveryNode sourceNode, RecoveryState.Index index)

RecoveryState

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

Throws:

java.io.IOException

Method Details

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

getShardId

public ShardId getShardId()

getStage

public RecoveryState.Stage getStage()

validateAndSetStage

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

validateCurrentStage

public void validateCurrentStage(RecoveryState.Stage expected)

setStage

public RecoveryState setStage(RecoveryState.Stage stage)

getIndex

public RecoveryState.Index getIndex()

getVerifyIndex

public RecoveryState.VerifyIndex getVerifyIndex()

getTranslog

public RecoveryState.Translog getTranslog()

getTimer

public RecoveryState.Timer getTimer()

getRecoverySource

public RecoverySource getRecoverySource()

getSourceNode

@Nullable public DiscoveryNode getSourceNode()

Returns recovery source node (only non-null if peer recovery)

getTargetNode

public DiscoveryNode getTargetNode()

getPrimary

public boolean getPrimary()

readRecoveryState

public static RecoveryState readRecoveryState(StreamInput in) throws java.io.IOException

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