Module org.elasticsearch.xcore
Class DeprecationIssue
java.lang.Object
org.elasticsearch.xpack.core.deprecation.DeprecationIssue
- All Implemented Interfaces:
Writeable,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject
public class DeprecationIssue
extends Object
implements Writeable, org.elasticsearch.xcontent.ToXContentObject
Information about deprecated items
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.ParamsNested 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
ConstructorsConstructorDescriptionDeprecationIssue(DeprecationIssue.Level level, String message, String url, String details, boolean resolveDuringRollingUpgrade, Map<String, Object> meta) -
Method Summary
Modifier and TypeMethodDescriptioncreateMetaMapForRemovableSettings(List<String> removableSettings) booleanstatic DeprecationIssuegetIntersectionOfRemovableSettings(List<DeprecationIssue> similarIssues) This method returns a DeprecationIssue that has in its meta object the intersection of all auto-removable settings that appear on all of the DeprecationIssues that are passed in.getLevel()getMeta()getUrl()inthashCode()booleantoString()org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
DeprecationIssue
-
DeprecationIssue
- Throws:
IOException
-
-
Method Details
-
getLevel
-
getMessage
-
getUrl
-
getDetails
-
isResolveDuringRollingUpgrade
public boolean isResolveDuringRollingUpgrade()- Returns:
- whether a deprecation issue can only be resolved during a rolling upgrade when a node is offline.
-
getMeta
- Returns:
- custom metadata, which allows the ui to display additional details without parsing the deprecation message itself.
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
equals
-
hashCode
public int hashCode() -
toString
-
createMetaMapForRemovableSettings
-
getIntersectionOfRemovableSettings
public static DeprecationIssue getIntersectionOfRemovableSettings(List<DeprecationIssue> similarIssues) This method returns a DeprecationIssue that has in its meta object the intersection of all auto-removable settings that appear on all of the DeprecationIssues that are passed in. This method assumes that all DeprecationIssues passed in are equal, except for the auto-removable settings in the meta object.- Parameters:
similarIssues- DeprecationIssues that are assumed to be identical except possibly removal actions.- Returns:
- A DeprecationIssue containing only the removal actions that are in all similarIssues
-