org.elasticsearch.cluster.routing

Class RecoverySource

java.lang.Object

org.elasticsearch.cluster.routing.RecoverySource

All Implemented Interfaces:

Writeable, ToXContent

Direct Known Subclasses:

RecoverySource.LocalShardsRecoverySource, RecoverySource.PeerRecoverySource, RecoverySource.SnapshotRecoverySource, RecoverySource.StoreRecoverySource

public abstract class RecoverySource
extends java.lang.Object
implements Writeable, ToXContent

Represents the recovery source of a shard. Available recovery types are: - RecoverySource.StoreRecoverySource recovery from the local store (empty or with existing data) - RecoverySource.PeerRecoverySource recovery from a primary on another node - RecoverySource.SnapshotRecoverySource recovery from a snapshot - RecoverySource.LocalShardsRecoverySource recovery from other shards of another index on the same node

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecoverySource.LocalShardsRecoverySource recovery from other shards on same node (shrink index action)
static class	RecoverySource.PeerRecoverySource peer recovery from a primary shard
static class	RecoverySource.SnapshotRecoverySource recovery from a snapshot
static class	RecoverySource.StoreRecoverySource recovery from an existing on-disk store or a fresh copy
static class	RecoverySource.Type

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
RecoverySource()

Method Summary

Modifier and Type	Method and Description
void	addAdditionalFields(XContentBuilder builder, ToXContent.Params params) to be overridden by subclasses
boolean	equals(java.lang.Object o)
abstract RecoverySource.Type	getType()
int	hashCode()
static boolean	isInitialRecovery(RecoverySource.Type type) returns true for recovery types that indicate that a primary is being allocated for the very first time.
static RecoverySource	readFrom(StreamInput in)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
protected void	writeAdditionalFields(StreamOutput out) to be overridden by subclasses
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecoverySource

public RecoverySource()

Method Detail

toXContent

public final XContentBuilder toXContent(XContentBuilder builder,
                                        ToXContent.Params params)
                                 throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

addAdditionalFields

public void addAdditionalFields(XContentBuilder builder,
                                ToXContent.Params params)
                         throws java.io.IOException

to be overridden by subclasses

Throws:

java.io.IOException

readFrom

public static RecoverySource readFrom(StreamInput in)
                               throws java.io.IOException

Throws:

java.io.IOException

writeTo

public final 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

writeAdditionalFields

protected void writeAdditionalFields(StreamOutput out)
                              throws java.io.IOException

to be overridden by subclasses

Throws:

java.io.IOException

getType

public abstract RecoverySource.Type getType()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isInitialRecovery

public static boolean isInitialRecovery(RecoverySource.Type type)

returns true for recovery types that indicate that a primary is being allocated for the very first time. This recoveries can be controlled by IndexMetaData.INDEX_ROUTING_INITIAL_RECOVERY_GROUP_SETTING