java.lang.Object
org.elasticsearch.upgrades.FeatureMigrationResults
- All Implemented Interfaces:
Diffable<Metadata.Custom>
,Metadata.Custom
,NamedDiffable<Metadata.Custom>
,NamedWriteable
,VersionedNamedWriteable
,Writeable
,ToXContent
,ToXContentFragment
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/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
Modifier and TypeFieldDescriptionstatic final Version
static final ConstructingObjectParser<FeatureMigrationResults,
Void> static final String
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionFeatureMigrationResults
(Map<String, SingleFeatureMigrationResult> featureStatuses) -
Method Summary
Modifier and TypeMethodDescriptioncontext()
diff
(Metadata.Custom previousState) Returns serializable object representing differences between this and previousStateboolean
static FeatureMigrationResults
fromXContent
(XContentParser parser) Gets a map of feature name to that feature's status.The minimal version of the recipient this object can be sent toReturns the name of the writeable objectint
hashCode()
static NamedDiff<Metadata.Custom>
toString()
toXContent
(XContentBuilder builder, ToXContent.Params params) 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.cluster.metadata.Metadata.Custom
isRestorable
Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
TYPE
- See Also:
-
MIGRATION_ADDED_VERSION
-
PARSER
-
-
Constructor Details
-
FeatureMigrationResults
-
FeatureMigrationResults
- Throws:
IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceToXContent
- Throws:
IOException
-
fromXContent
-
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
Convenience method for updating the results of a migration run. Produces a newFeatureMigrationResults
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 givenfeatureName
.- Returns:
- A new
FeatureMigrationResults
with the given status associated with the given feature name. Other entries in the map are unchanged.
-
context
- Specified by:
context
in interfaceMetadata.Custom
-
getWriteableName
Description copied from interface:VersionedNamedWriteable
Returns the name of the writeable object- Specified by:
getWriteableName
in interfaceNamedWriteable
- Specified by:
getWriteableName
in interfaceVersionedNamedWriteable
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteable
The minimal version of the recipient this object can be sent to- Specified by:
getMinimalSupportedVersion
in interfaceVersionedNamedWriteable
-
toString
-
equals
-
hashCode
public int hashCode() -
diff
Description copied from interface:Diffable
Returns serializable object representing differences between this and previousState- Specified by:
diff
in interfaceDiffable<Metadata.Custom>
-
readDiffFrom
- Throws:
IOException
-