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

Class Detector

java.lang.Object
org.elasticsearch.client.ml.job.config.Detector
All Implemented Interfaces:
org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class Detector extends Object implements org.elasticsearch.xcontent.ToXContentObject
Defines the fields and functions used in the analysis. A combination of field_name, by_field_name and over_field_name can be used depending on the specific function chosen. For more information see configuring detectors and detector functions.

  • Field Details

    • DETECTOR_DESCRIPTION_FIELD

      public static final org.elasticsearch.xcontent.ParseField DETECTOR_DESCRIPTION_FIELD

    • FUNCTION_FIELD

      public static final org.elasticsearch.xcontent.ParseField FUNCTION_FIELD

    • FIELD_NAME_FIELD

      public static final org.elasticsearch.xcontent.ParseField FIELD_NAME_FIELD

    • BY_FIELD_NAME_FIELD

      public static final org.elasticsearch.xcontent.ParseField BY_FIELD_NAME_FIELD

    • OVER_FIELD_NAME_FIELD

      public static final org.elasticsearch.xcontent.ParseField OVER_FIELD_NAME_FIELD

    • PARTITION_FIELD_NAME_FIELD

      public static final org.elasticsearch.xcontent.ParseField PARTITION_FIELD_NAME_FIELD

    • USE_NULL_FIELD

      public static final org.elasticsearch.xcontent.ParseField USE_NULL_FIELD

    • EXCLUDE_FREQUENT_FIELD

      public static final org.elasticsearch.xcontent.ParseField EXCLUDE_FREQUENT_FIELD

    • CUSTOM_RULES_FIELD

      public static final org.elasticsearch.xcontent.ParseField CUSTOM_RULES_FIELD

    • DETECTOR_INDEX

      public static final org.elasticsearch.xcontent.ParseField DETECTOR_INDEX

    • PARSER

      public static final org.elasticsearch.xcontent.ObjectParser<Detector.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

    • getDetectorDescription

      public String getDetectorDescription()

    • getFunction

      public DetectorFunction getFunction()
      The analysis function used e.g. count, rare, min etc.
      Returns:
      The function or null if not set

    • getFieldName

      public String getFieldName()
      The Analysis field
      Returns:
      The field to analyse

    • getByFieldName

      public String getByFieldName()
      The 'by' field or null if not set.
      Returns:
      The 'by' field

    • getOverFieldName

      public String getOverFieldName()
      The 'over' field or null if not set.
      Returns:
      The 'over' field

    • getPartitionFieldName

      public String getPartitionFieldName()
      Segments the analysis along another field to have completely independent baselines for each instance of partitionfield
      Returns:
      The Partition Field

    • isUseNull

      public boolean isUseNull()
      Where there isn't a value for the 'by' or 'over' field should a new series be used as the 'null' series.
      Returns:
      true if the 'null' series should be created

    • getExcludeFrequent

      public Detector.ExcludeFrequent getExcludeFrequent()
      Excludes frequently-occurring metrics from the analysis; can apply to 'by' field, 'over' field, or both
      Returns:
      the value that the user set

    • getRules

      public List<DetectionRule> getRules()

    • getDetectorIndex

      public int getDetectorIndex()
      Returns:
      the detector index or a negative number if unknown

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • builder

      public static Detector.Builder builder()