Package co.elastic.clients.elasticsearch.ml

Class Detector

java.lang.Object
co.elastic.clients.elasticsearch.ml.Detector
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class Detector extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

      public static Detector of(Function<Detector.Builder,ObjectBuilder<Detector>> fn)

    • byFieldName

      @Nullable public final String byFieldName()
      The field used to split the data. In particular, this property is used for analyzing the splits with respect to their own history. It is used for finding unusual values in the context of the split.

      API name: by_field_name

    • customRules

      public final List<DetectionRule> customRules()
      Custom rules enable you to customize the way detectors operate. For example, a rule may dictate conditions under which results should be skipped. Kibana refers to custom rules as job rules.

      API name: custom_rules

    • detectorDescription

      @Nullable public final String detectorDescription()
      A description of the detector.

      API name: detector_description

    • detectorIndex

      @Nullable public final Integer detectorIndex()
      A unique identifier for the detector. This identifier is based on the order of the detectors in the analysis_config, starting at zero. If you specify a value for this property, it is ignored.

      API name: detector_index

    • excludeFrequent

      @Nullable public final ExcludeFrequent excludeFrequent()
      If set, frequent entities are excluded from influencing the anomaly results. Entities can be considered frequent over time or frequent in a population. If you are working with both over and by fields, you can set exclude_frequent to all for both fields, or to by or over for those specific fields.

      API name: exclude_frequent

    • fieldName

      @Nullable public final String fieldName()
      The field that the detector uses in the function. If you use an event rate function such as count or rare, do not specify this field. The field_name cannot contain double quotes or backslashes.

      API name: field_name

    • function

      @Nullable public final String function()
      The analysis function that is used. For example, count, rare, mean, min, max, or sum.

      API name: function

    • overFieldName

      @Nullable public final String overFieldName()
      The field used to split the data. In particular, this property is used for analyzing the splits with respect to the history of all splits. It is used for finding unusual values in the population of all splits.

      API name: over_field_name

    • partitionFieldName

      @Nullable public final String partitionFieldName()
      The field used to segment the analysis. When you use this property, you have completely independent baselines for each value of this field.

      API name: partition_field_name

    • useNull

      @Nullable public final Boolean useNull()
      Defines whether a new series is used as the null series when there is no value for the by or partition fields.

      API name: use_null

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupDetectorDeserializer

      protected static void setupDetectorDeserializer(ObjectDeserializer<Detector.Builder> op)