Package org.elasticsearch.client.ml.job.config

Class MlFilter

java.lang.Object
org.elasticsearch.client.ml.job.config.MlFilter
All Implemented Interfaces:
org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class MlFilter extends Object implements org.elasticsearch.xcontent.ToXContentObject
An MlFilter Object A filter contains a list of strings. It can be used by one or more jobs. Specifically, filters are referenced in the custom_rules property of detector configuration objects.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    MlFilter.Builder
     

    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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.elasticsearch.xcontent.ParseField
    DESCRIPTION
     
    static final org.elasticsearch.xcontent.ParseField
    ID
     
    static final org.elasticsearch.xcontent.ParseField
    ITEMS
     
    static final org.elasticsearch.xcontent.ObjectParser<MlFilter.Builder,Void>
    PARSER
     
    static final org.elasticsearch.xcontent.ParseField
    RESULTS_FIELD
     
    static final org.elasticsearch.xcontent.ParseField
    TYPE
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type
    Method
    Description
    static MlFilter.Builder
    builder(String filterId)
    Creates a new Builder object for creating an MlFilter object
    boolean
    equals(Object obj)
     
    String
    getDescription()
     
    String
    getId()
     
    SortedSet<String>
    getItems()
     
    int
    hashCode()
     
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment

  • Field Details

    • TYPE

      public static final org.elasticsearch.xcontent.ParseField TYPE

    • ID

      public static final org.elasticsearch.xcontent.ParseField ID

    • DESCRIPTION

      public static final org.elasticsearch.xcontent.ParseField DESCRIPTION

    • ITEMS

      public static final org.elasticsearch.xcontent.ParseField ITEMS

    • RESULTS_FIELD

      public static final org.elasticsearch.xcontent.ParseField RESULTS_FIELD

    • PARSER

      public static final org.elasticsearch.xcontent.ObjectParser<MlFilter.Builder,Void> PARSER

  • Method Details

    • 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

    • getId

      public String getId()

    • getDescription

      public String getDescription()

    • getItems

      public SortedSet<String> getItems()

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • builder

      public static MlFilter.Builder builder(String filterId)
      Creates a new Builder object for creating an MlFilter object
      Parameters:
      filterId - The ID of the filter to create