Package org.elasticsearch.upgrades

Class SingleFeatureMigrationResult

java.lang.Object

org.elasticsearch.cluster.AbstractDiffable<SingleFeatureMigrationResult>

org.elasticsearch.upgrades.SingleFeatureMigrationResult

All Implemented Interfaces:

Diffable<SingleFeatureMigrationResult>, Writeable, ToXContent

public class SingleFeatureMigrationResult
extends AbstractDiffable<SingleFeatureMigrationResult>
implements Writeable, ToXContent

Holds the results of migrating a single feature. See also FeatureMigrationResults.

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_PARAMS

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static SingleFeatureMigrationResult	failure(String failedIndexName, Exception exception)	Creates a record indicating that migration failed.
static SingleFeatureMigrationResult	fromXContent(XContentParser parser)
Exception	getException()	Gets the exception that cause the migration failure, if the migration failed.
String	getFailedIndexName()	Gets the name of the specific index where the migration failure occurred, if the migration failed.
int	hashCode()
boolean	isFragment()
boolean	succeeded()	Returns true if the migration of this feature's data succeeded, or false otherwise.
static SingleFeatureMigrationResult	success()	Creates a record indicating that migration succeeded.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.cluster.AbstractDiffable

diff, readDiffFrom

Methods inherited from class java.lang.Object

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

Method Details

fromXContent

public static SingleFeatureMigrationResult fromXContent(XContentParser parser)

success

public static SingleFeatureMigrationResult success()

Creates a record indicating that migration succeeded.

failure

public static SingleFeatureMigrationResult failure(String failedIndexName,
 Exception exception)

Creates a record indicating that migration failed.

Parameters:

failedIndexName - The name of the specific index whose migration failed.

exception - The exception which caused the migration failure.

succeeded

public boolean succeeded()

Returns true if the migration of this feature's data succeeded, or false otherwise.

getFailedIndexName

@Nullable
public String getFailedIndexName()

Gets the name of the specific index where the migration failure occurred, if the migration failed.

getException

@Nullable
public Exception getException()

Gets the exception that cause the migration failure, if the migration failed.

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

isFragment

public boolean isFragment()

Specified by:

isFragment in interface ToXContent

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object