Module org.elasticsearch.server

Package org.elasticsearch.upgrades

Class SystemIndexMigrationTaskState

java.lang.Object

org.elasticsearch.upgrades.SystemIndexMigrationTaskState

All Implemented Interfaces:

NamedWriteable, Writeable, PersistentTaskState, ToXContent, ToXContentObject

public class SystemIndexMigrationTaskState
extends Object
implements PersistentTaskState

Contains the current state of system index migration progress. Used to resume runs if there's a node failure during migration.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SystemIndexMigrationTaskState(String currentIndex, String currentFeature, Map<String,Object> featureCallbackMetadata)
SystemIndexMigrationTaskState(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static SystemIndexMigrationTaskState	fromXContent(XContentParser parser)
String	getCurrentFeature()	Gets the name of the feature which owns the index that's currently being migrated.
String	getCurrentIndex()	Gets the name of the index that's currently being migrated.
Map<String,Object>	getFeatureCallbackMetadata()	Retrieves metadata stored by the pre-upgrade hook, intended for consumption by the post-migration hook.
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

SystemIndexMigrationTaskState

public SystemIndexMigrationTaskState(String currentIndex,
 String currentFeature,
 Map<String,Object> featureCallbackMetadata)

SystemIndexMigrationTaskState

public SystemIndexMigrationTaskState(StreamInput in)
                              throws IOException

Throws:

IOException

Method Details

getCurrentIndex

public String getCurrentIndex()

Gets the name of the index that's currently being migrated.

getCurrentFeature

public String getCurrentFeature()

Gets the name of the feature which owns the index that's currently being migrated.

getFeatureCallbackMetadata

public Map<String,Object> getFeatureCallbackMetadata()

Retrieves metadata stored by the pre-upgrade hook, intended for consumption by the post-migration hook. See SystemIndexPlugin.prepareForIndicesMigration(ClusterService, Client, ActionListener) and SystemIndexPlugin.indicesMigrationComplete(Map, ClusterService, Client, ActionListener) for details on the pre- and post-migration hooks.

fromXContent

public static SystemIndexMigrationTaskState fromXContent(XContentParser parser)
                                                  throws IOException

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object