Package co.elastic.clients.elasticsearch.ml

Class DetectorRead.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<DetectorRead.Builder>
co.elastic.clients.elasticsearch.ml.DetectorRead.Builder
All Implemented Interfaces:
WithJson<DetectorRead.Builder>, ObjectBuilder<DetectorRead>
Enclosing class:
DetectorRead
public static class DetectorRead.Builder extends WithJsonObjectBuilderBase<DetectorRead.Builder> implements ObjectBuilder<DetectorRead>
Builder for DetectorRead.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • byFieldName

      public final DetectorRead.Builder byFieldName(@Nullable String value)
      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 DetectorRead.Builder customRules(List<DetectionRule> list)
      An array of custom rule objects, which enable you to customize the way detectors operate. For example, a rule may dictate to the detector conditions under which results should be skipped. Kibana refers to custom rules as job rules.

      API name: custom_rules

      Adds all elements of list to customRules.

    • customRules

      public final DetectorRead.Builder customRules(DetectionRule value, DetectionRule... values)
      An array of custom rule objects, which enable you to customize the way detectors operate. For example, a rule may dictate to the detector conditions under which results should be skipped. Kibana refers to custom rules as job rules.

      API name: custom_rules

      Adds one or more values to customRules.

    • customRules

      public final DetectorRead.Builder customRules(Function<DetectionRule.Builder,ObjectBuilder<DetectionRule>> fn)
      An array of custom rule objects, which enable you to customize the way detectors operate. For example, a rule may dictate to the detector conditions under which results should be skipped. Kibana refers to custom rules as job rules.

      API name: custom_rules

      Adds a value to customRules using a builder lambda.

    • detectorDescription

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

      API name: detector_description

    • detectorIndex

      public final DetectorRead.Builder detectorIndex(@Nullable Integer value)
      A unique identifier for the detector. This identifier is based on the order of the detectors in the analysis_config, starting at zero.

      API name: detector_index

    • excludeFrequent

      public final DetectorRead.Builder excludeFrequent(@Nullable ExcludeFrequent value)
      Contains one of the following values: all, none, by, or over. 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, then you can set exclude_frequent to all for both fields, or to by or over for those specific fields.

      API name: exclude_frequent

    • fieldName

      public final DetectorRead.Builder fieldName(@Nullable String value)
      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.

      API name: field_name

    • function

      public final DetectorRead.Builder function(String value)
      Required - The analysis function that is used. For example, count, rare, mean, min, max, and sum.

      API name: function

    • overFieldName

      public final DetectorRead.Builder overFieldName(@Nullable String value)
      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

      public final DetectorRead.Builder partitionFieldName(@Nullable String value)
      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

      public final DetectorRead.Builder useNull(@Nullable Boolean value)
      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

    • self

      protected DetectorRead.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<DetectorRead.Builder>

    • build

      public DetectorRead build()
      Builds a DetectorRead.
      Specified by:
      build in interface ObjectBuilder<DetectorRead>
      Throws:
      NullPointerException - if some of the required fields are null.