Class ResetFeatureStateResponse.ResetFeatureStateStatus
java.lang.Object
org.elasticsearch.action.admin.cluster.snapshots.features.ResetFeatureStateResponse.ResetFeatureStateStatus
- All Implemented Interfaces:
Writeable
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
- Enclosing class:
- ResetFeatureStateResponse
public static class ResetFeatureStateResponse.ResetFeatureStateStatus
extends Object
implements Writeable, org.elasticsearch.xcontent.ToXContentObject
An object with the name of a feature and a message indicating success or
failure.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Success or failure enum.Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.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 TypeMethodDescriptionboolean
Without a convenient way to compare Exception equality, we consider only feature name and success or failure for equality.Create a feature status for a failed reset operationint
hashCode()
Create a feature status for a successful reset operationtoString()
org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.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
-
Method Details
-
success
Create a feature status for a successful reset operation- Parameters:
featureName
- Name of the feature whose state was successfully reset- Returns:
- Success status for a feature
-
failure
public static ResetFeatureStateResponse.ResetFeatureStateStatus failure(String featureName, Exception exception) Create a feature status for a failed reset operation- Parameters:
featureName
- Name of the feature that failedexception
- The exception that caused or described the failure- Returns:
- Failure status for a feature
-
getFeatureName
- Returns:
- Name of the feature we tried to reset
-
getStatus
- Returns:
- Success or failure for the reset operation
-
getException
- Returns:
- For a failed reset operation, the exception that caused or describes the failure.
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
equals
Without a convenient way to compare Exception equality, we consider only feature name and success or failure for equality. -
hashCode
public int hashCode() -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
toString
-