Package org.opensearch.cluster.routing

Class RecoverySource.RemoteStoreRecoverySource

java.lang.Object

org.opensearch.cluster.routing.RecoverySource

org.opensearch.cluster.routing.RecoverySource.RemoteStoreRecoverySource

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject

Enclosing class:

RecoverySource

@PublicApi(since="1.0.0")
public static class RecoverySource.RemoteStoreRecoverySource
extends RecoverySource

Recovery from remote store

Opensearch.api:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.cluster.routing.RecoverySource

RecoverySource.EmptyStoreRecoverySource, RecoverySource.ExistingStoreRecoverySource, RecoverySource.LocalShardsRecoverySource, RecoverySource.PeerRecoverySource, RecoverySource.RemoteStoreRecoverySource, RecoverySource.SnapshotRecoverySource, RecoverySource.Type

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
RemoteStoreRecoverySource(String restoreUUID, org.opensearch.Version version, IndexId indexId)

Method Summary

Modifier and Type	Method	Description
void	addAdditionalFields(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)	to be overridden by subclasses
boolean	equals(Object o)
boolean	expectEmptyRetentionLeases()
RecoverySource.Type	getType()
int	hashCode()
IndexId	index()	Gets the IndexId of the recovery source.
String	restoreUUID()
String	toString()
org.opensearch.Version	version()
protected void	writeAdditionalFields(org.opensearch.core.common.io.stream.StreamOutput out)	to be overridden by subclasses

Methods inherited from class org.opensearch.cluster.routing.RecoverySource

readFrom, shouldBootstrapNewHistoryUUID, toXContent, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isFragment

Constructor Details

RemoteStoreRecoverySource

public RemoteStoreRecoverySource(String restoreUUID,
 org.opensearch.Version version,
 IndexId indexId)

Method Details

restoreUUID

public String restoreUUID()

index

public IndexId index()

Gets the IndexId of the recovery source. May contain IndexMetadata.INDEX_UUID_NA_VALUE as the index uuid if it was created by an older version cluster-manager in a mixed version cluster.

Returns:

IndexId

version

public org.opensearch.Version version()

writeAdditionalFields

protected void writeAdditionalFields(org.opensearch.core.common.io.stream.StreamOutput out)
                              throws IOException

Description copied from class: RecoverySource

to be overridden by subclasses

Overrides:

writeAdditionalFields in class RecoverySource

Throws:

IOException

getType

public RecoverySource.Type getType()

Specified by:

getType in class RecoverySource

addAdditionalFields

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

Description copied from class: RecoverySource

to be overridden by subclasses

Overrides:

addAdditionalFields in class RecoverySource

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class RecoverySource

hashCode

public int hashCode()

Overrides:

hashCode in class RecoverySource

expectEmptyRetentionLeases

public boolean expectEmptyRetentionLeases()

Overrides:

expectEmptyRetentionLeases in class RecoverySource