Module org.elasticsearch.server

Package org.elasticsearch.upgrades

Class FeatureMigrationResults

java.lang.Object

org.elasticsearch.upgrades.FeatureMigrationResults

All Implemented Interfaces:

Diffable<Metadata.Custom>, Metadata.Custom, NamedDiffable<Metadata.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, ChunkedToXContent

public class FeatureMigrationResults
extends Object
implements Metadata.Custom

Holds the results of the most recent attempt to migrate system indices. Updated by SystemIndexMigrator as it finishes each feature, or fails.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FeatureMigrationResults.ResultsDiff

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final TransportVersion	MIGRATION_ADDED_VERSION
static final ConstructingObjectParser<FeatureMigrationResults,Void>	PARSER
static final String	TYPE

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
FeatureMigrationResults(Map<String,SingleFeatureMigrationResult> featureStatuses)
FeatureMigrationResults(StreamInput in)

Method Summary

Modifier and Type	Method	Description
EnumSet<Metadata.XContentContext>	context()
Diff<Metadata.Custom>	diff(Metadata.Custom previousState)	Returns serializable object representing differences between this and previousState
boolean	equals(Object o)
static FeatureMigrationResults	fromXContent(XContentParser parser)
Map<String,SingleFeatureMigrationResult>	getFeatureStatuses()	Gets a map of feature name to that feature's status.
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
static NamedDiff<Metadata.Custom>	readDiffFrom(StreamInput in)
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params ignored)	Create an iterator of ToXContent chunks for a REST response.
FeatureMigrationResults	withResult(String featureName, SingleFeatureMigrationResult status)	Convenience method for updating the results of a migration run.
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.common.xcontent.ChunkedToXContent

isFragment, toXContentChunkedV7

Methods inherited from interface org.elasticsearch.cluster.metadata.Metadata.Custom

isRestorable

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

MIGRATION_ADDED_VERSION

public static final TransportVersion MIGRATION_ADDED_VERSION

PARSER

public static final ConstructingObjectParser<FeatureMigrationResults,Void> PARSER

Constructor Details

FeatureMigrationResults

public FeatureMigrationResults(Map<String,SingleFeatureMigrationResult> featureStatuses)

FeatureMigrationResults

public FeatureMigrationResults(StreamInput in)
                        throws IOException

Throws:

IOException

Method Details

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

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params ignored)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent

fromXContent

public static FeatureMigrationResults fromXContent(XContentParser parser)

getFeatureStatuses

public Map<String,SingleFeatureMigrationResult> getFeatureStatuses()

Gets a map of feature name to that feature's status. Only contains features which have either been migrated successfully or failed to migrate.

Returns:

An unmodifiable map of feature names to migration statuses.

withResult

public FeatureMigrationResults withResult(String featureName,
 SingleFeatureMigrationResult status)

Convenience method for updating the results of a migration run. Produces a new FeatureMigrationResults updated with the given status for the given feature name.

Parameters:

featureName - The feature name to update. If this feature name is already present, its status will be overwritten.

status - The status that should be associated with the given featureName.

Returns:

A new FeatureMigrationResults with the given status associated with the given feature name. Other entries in the map are unchanged.

context

public EnumSet<Metadata.XContentContext> context()

Specified by:

context in interface Metadata.Custom

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

diff

public Diff<Metadata.Custom> diff(Metadata.Custom previousState)

Description copied from interface: Diffable

Returns serializable object representing differences between this and previousState

Specified by:

diff in interface Diffable<Metadata.Custom>

readDiffFrom

public static NamedDiff<Metadata.Custom> readDiffFrom(StreamInput in)
                                               throws IOException

Throws:

IOException