Package org.opensearch.indices.recovery

Class RecoveryState.Index

java.lang.Object

org.opensearch.indices.recovery.RecoveryState.Timer

org.opensearch.indices.recovery.RecoveryState.Index

All Implemented Interfaces:

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

Enclosing class:

RecoveryState

public static class RecoveryState.Index
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 long	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
Index()
Index(StreamInput in)
Index(RecoveryState.RecoveryFilesDetails recoveryFilesDetails)

Method Summary

Modifier and Type	Method	Description
void	addFileDetail(java.lang.String name, long length, boolean reused)
void	addRecoveredBytesToFile(java.lang.String name, long bytes)
void	addSourceThrottling(long timeInNanos)
void	addTargetThrottling(long timeInNanos)
long	bytesStillToRecover()
java.util.List<RecoveryState.FileDetail>	fileDetails()
RecoveryState.FileDetail	getFileDetails(java.lang.String dest)
long	recoveredBytes()	total number of bytes recovered so far, including both existing and reused
float	recoveredBytesPercent()	percent of bytes recovered out of total files bytes *to be* recovered
int	recoveredFileCount()	number of file that were recovered (excluding on ongoing files)
float	recoveredFilesPercent()	percent of recovered (i.e., not reused) files out of the total files to be recovered
void	reset()
long	reusedBytes()
int	reusedFileCount()
void	setFileDetailsComplete()
org.opensearch.common.unit.TimeValue	sourceThrottling()
org.opensearch.common.unit.TimeValue	targetThrottling()
java.lang.String	toString()
long	totalBytes()	total number of bytes in th shard
int	totalFileCount()	total number of files that are part of this recovery, both re-used and recovered
long	totalRecoverBytes()	total bytes of files to be recovered (potentially not yet done)
int	totalRecoverFiles()	total number of files to be recovered (potentially not yet done)
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, wait, wait, wait

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

isFragment

Field Details

UNKNOWN

public static final long UNKNOWN

See Also:

Constant Field Values

Constructor Details

Index

public Index()

Index

public Index(RecoveryState.RecoveryFilesDetails recoveryFilesDetails)

Index

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

fileDetails

public java.util.List<RecoveryState.FileDetail> fileDetails()

reset

public void reset()

Overrides:

reset in class RecoveryState.Timer

addFileDetail

public void addFileDetail(java.lang.String name, long length, boolean reused)

setFileDetailsComplete

public void setFileDetailsComplete()

addRecoveredBytesToFile

public void addRecoveredBytesToFile(java.lang.String name, long bytes)

addSourceThrottling

public void addSourceThrottling(long timeInNanos)

addTargetThrottling

public void addTargetThrottling(long timeInNanos)

sourceThrottling

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

targetThrottling

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

totalFileCount

public int totalFileCount()

total number of files that are part of this recovery, both re-used and recovered

totalRecoverFiles

public int totalRecoverFiles()

total number of files to be recovered (potentially not yet done)

recoveredFileCount

public int recoveredFileCount()

number of file that were recovered (excluding on ongoing files)

recoveredFilesPercent

public float recoveredFilesPercent()

percent of recovered (i.e., not reused) files out of the total files to be recovered

totalBytes

public long totalBytes()

total number of bytes in th shard

recoveredBytes

public long recoveredBytes()

total number of bytes recovered so far, including both existing and reused

totalRecoverBytes

public long totalRecoverBytes()

total bytes of files to be recovered (potentially not yet done)

bytesStillToRecover

public long bytesStillToRecover()

Returns:

number of bytes still to recover, i.e. totalRecoverBytes() minus recoveredBytes(), or -1 if the full set of files to recover is not yet known

recoveredBytesPercent

public float recoveredBytesPercent()

percent of bytes recovered out of total files bytes *to be* recovered

reusedFileCount

public int reusedFileCount()

reusedBytes

public long reusedBytes()

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getFileDetails

public RecoveryState.FileDetail getFileDetails(java.lang.String dest)