Package org.opensearch.indices.recovery

Class RecoveryState.Translog

java.lang.Object

org.opensearch.indices.recovery.RecoveryState.Timer

org.opensearch.indices.recovery.RecoveryState.Translog

All Implemented Interfaces:

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

Enclosing class:

RecoveryState

public static class RecoveryState.Translog
extends RecoveryState.Timer
implements org.opensearch.common.xcontent.ToXContentFragment, Writeable

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

Modifier and Type	Field	Description
static int	UNKNOWN

Fields inherited from class org.opensearch.indices.recovery.RecoveryState.Timer

startNanoTime, startTime, stopTime, time

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Translog()
Translog(StreamInput in)

Method Summary

Modifier and Type	Method	Description
void	decrementRecoveredOperations(int ops)
void	incrementRecoveredOperations()
void	incrementRecoveredOperations(int ops)
int	recoveredOperations()	returns the total number of translog operations recovered so far
float	recoveredPercent()
void	reset()
int	totalLocal()
void	totalLocal(int totalLocal)	Sets the total number of translog operations to be recovered locally before performing peer recovery
int	totalOperations()	returns the total number of translog operations needed to be recovered at this moment.
void	totalOperations(int total)
int	totalOperationsOnStart()	returns the total number of translog operations to recovered, on the start of the recovery.
void	totalOperationsOnStart(int total)
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 org.opensearch.indices.recovery.RecoveryState.Timer

getStartNanoTime, start, startTime, stop, stopTime, time

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

Field Details

UNKNOWN

public static final int UNKNOWN

See Also:

Constant Field Values

Constructor Details

Translog

public Translog()

Translog

public Translog(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

Overrides:

writeTo in class RecoveryState.Timer

Throws:

java.io.IOException

reset

public void reset()

Overrides:

reset in class RecoveryState.Timer

incrementRecoveredOperations

public void incrementRecoveredOperations()

incrementRecoveredOperations

public void incrementRecoveredOperations(int ops)

decrementRecoveredOperations

public void decrementRecoveredOperations(int ops)

recoveredOperations

public int recoveredOperations()

returns the total number of translog operations recovered so far

totalOperations

public int totalOperations()

returns the total number of translog operations needed to be recovered at this moment. Note that this can change as the number of operations grows during recovery.

A value of -1 (UNKNOWN is return if this is unknown (typically a gateway recovery)

totalOperations

public void totalOperations(int total)

totalOperationsOnStart

public int totalOperationsOnStart()

returns the total number of translog operations to recovered, on the start of the recovery. Unlike totalOperations() this does change during recovery.

A value of -1 (UNKNOWN is return if this is unknown (typically a gateway recovery)

totalOperationsOnStart

public void totalOperationsOnStart(int total)

totalLocal

public void totalLocal(int totalLocal)

Sets the total number of translog operations to be recovered locally before performing peer recovery

See Also:

IndexShard.recoverLocallyUpToGlobalCheckpoint()

totalLocal

public int totalLocal()

recoveredPercent

public float recoveredPercent()

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