Package org.opensearch.cluster.routing

Class RecoverySource.SnapshotRecoverySource

java.lang.Object

org.opensearch.cluster.routing.RecoverySource

org.opensearch.cluster.routing.RecoverySource.SnapshotRecoverySource

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.SnapshotRecoverySource
extends RecoverySource

recovery from a snapshot

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

Modifier and Type	Field	Description
static final String	NO_API_RESTORE_UUID

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SnapshotRecoverySource(String restoreUUID, Snapshot snapshot, org.opensearch.Version version, IndexId indexId)
SnapshotRecoverySource(String restoreUUID, Snapshot snapshot, org.opensearch.Version version, IndexId indexId, boolean isSearchableSnapshot, boolean remoteStoreIndexShallowCopy, String sourceRemoteStoreRepository)

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)
RecoverySource.Type	getType()
int	hashCode()
IndexId	index()	Gets the IndexId of the recovery source.
boolean	isSearchableSnapshot()
boolean	remoteStoreIndexShallowCopy()
String	restoreUUID()
Snapshot	snapshot()
String	sourceRemoteStoreRepository()
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

expectEmptyRetentionLeases, 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

Field Details

NO_API_RESTORE_UUID

public static final String NO_API_RESTORE_UUID

See Also:

• Constant Field Values

Constructor Details

SnapshotRecoverySource

public SnapshotRecoverySource(String restoreUUID,
 Snapshot snapshot,
 org.opensearch.Version version,
 IndexId indexId)

SnapshotRecoverySource

public SnapshotRecoverySource(String restoreUUID,
 Snapshot snapshot,
 org.opensearch.Version version,
 IndexId indexId,
 boolean isSearchableSnapshot,
 boolean remoteStoreIndexShallowCopy,
 @Nullable
 String sourceRemoteStoreRepository)

Method Details

restoreUUID

public String restoreUUID()

snapshot

public Snapshot snapshot()

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()

isSearchableSnapshot

public boolean isSearchableSnapshot()

sourceRemoteStoreRepository

public String sourceRemoteStoreRepository()

remoteStoreIndexShallowCopy

public boolean remoteStoreIndexShallowCopy()

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