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

Class MlFilter

java.lang.Object
org.elasticsearch.client.ml.job.config.MlFilter
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class MlFilter
extends java.lang.Object
implements org.elasticsearch.common.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.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

  • Field Summary

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

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type Method Description
    static MlFilter.Builder builder​(java.lang.String filterId)
    Creates a new Builder object for creating an MlFilter object
    boolean equals​(java.lang.Object obj)  
    java.lang.String getDescription()  
    java.lang.String getId()  
    java.util.SortedSet<java.lang.String> getItems()  
    int hashCode()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.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.common.xcontent.ToXContentObject

    isFragment

  • Field Details

    • TYPE

      public static final org.elasticsearch.common.ParseField TYPE

    • ID

      public static final org.elasticsearch.common.ParseField ID

    • DESCRIPTION

      public static final org.elasticsearch.common.ParseField DESCRIPTION

    • ITEMS

      public static final org.elasticsearch.common.ParseField ITEMS

    • RESULTS_FIELD

      public static final org.elasticsearch.common.ParseField RESULTS_FIELD

    • PARSER

      public static final org.elasticsearch.common.xcontent.ObjectParser<MlFilter.Builder,​java.lang.Void> PARSER

  • Method Details

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • getId

      public java.lang.String getId()

    • getDescription

      public java.lang.String getDescription()

    • getItems

      public java.util.SortedSet<java.lang.String> getItems()

    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • builder

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