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
  • Constructor Details

  • Method Details

    • getLevel

      public DeprecationIssue.Level getLevel()
    • getMessage

      public String getMessage()
    • getUrl

      public String getUrl()
    • getDetails

      public String getDetails()
    • isResolveDuringRollingUpgrade

      public boolean isResolveDuringRollingUpgrade()
      Returns:
      whether a deprecation issue can only be resolved during a rolling upgrade when a node is offline.
    • getMeta

      public Map<String,Object> getMeta()
      Returns:
      custom metadata, which allows the ui to display additional details without parsing the deprecation message itself.
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException
    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • createMetaMapForRemovableSettings

      public static Map<String,Object> createMetaMapForRemovableSettings(List<String> removableSettings)
    • 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